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 |
| Transaction | y |
| System History | y |
| System Search | y |
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 |
| 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 |
| Transaction | |
| System History | |
| System Search |
| Resource Type | Profile | Read | Search | Update | Create |
|---|---|---|---|---|---|
| CapabilityStatement | 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 |
| Transaction | |
| System History | |
| System Search |
| Resource Type | Profile | Read | Search | Update | Create |
|---|---|---|---|---|---|
| CapabilityStatement | y |
\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 | sender, recipient |
| Composition | author |
| DetectedIssue | author |
| DeviceRequest | device, subject, requester, performer |
| DeviceUseStatement | device |
| DiagnosticReport | subject |
| DocumentManifest | subject, author |
| DocumentReference | subject, author |
| ExplanationOfBenefit | procedure-udi, item-udi, detail-udi, subdetail-udi |
| Flag | author |
| Group | member |
| Invoice | participant |
| List | subject, source |
| Media | subject |
| MedicationAdministration | device |
| MessageHeader | target |
| Observation | subject, device |
| Provenance | agent |
| QuestionnaireResponse | author |
| RequestGroup | author |
| 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 |
| CareTeam | encounter |
| ChargeItem | context |
| Claim | encounter |
| ClinicalImpression | encounter |
| Communication | encounter |
| CommunicationRequest | encounter |
| Composition | encounter |
| Condition | encounter |
| DeviceRequest | encounter |
| DiagnosticReport | encounter |
| DocumentManifest | related-ref |
| DocumentReference | encounter |
| Encounter | {def} |
| ExplanationOfBenefit | encounter |
| Media | encounter |
| MedicationAdministration | context |
| MedicationRequest | encounter |
| NutritionOrder | encounter |
| Observation | encounter |
| Procedure | encounter |
| QuestionnaireResponse | encounter |
| RequestGroup | 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, recorder, asserter |
| Appointment | actor |
| AppointmentResponse | actor |
| AuditEvent | patient |
| Basic | patient, author |
| BodyStructure | patient |
| CarePlan | patient, performer |
| CareTeam | patient, participant |
| ChargeItem | subject |
| Claim | patient, payee |
| ClaimResponse | patient |
| ClinicalImpression | subject |
| Communication | subject, sender, recipient |
| CommunicationRequest | subject, sender, recipient, requester |
| Composition | subject, author, attester |
| Condition | patient, asserter |
| Consent | patient |
| Coverage | policy-holder, subscriber, beneficiary, payor |
| CoverageEligibilityRequest | patient |
| CoverageEligibilityResponse | patient |
| DetectedIssue | patient |
| DeviceRequest | subject, performer |
| DeviceUseStatement | subject |
| DiagnosticReport | subject |
| DocumentManifest | subject, author, recipient |
| DocumentReference | subject, author |
| Encounter | patient |
| EnrollmentRequest | subject |
| EpisodeOfCare | patient |
| ExplanationOfBenefit | patient, payee |
| FamilyMemberHistory | patient |
| Flag | patient |
| Goal | patient |
| Group | member |
| ImagingStudy | patient |
| Immunization | patient |
| ImmunizationEvaluation | patient |
| ImmunizationRecommendation | patient |
| Invoice | subject, patient, recipient |
| List | subject, source |
| MeasureReport | patient |
| Media | subject |
| MedicationAdministration | patient, performer, subject |
| MedicationDispense | subject, patient, receiver |
| MedicationRequest | subject |
| MedicationStatement | subject |
| MolecularSequence | patient |
| NutritionOrder | patient |
| Observation | subject, performer |
| Patient | link |
| Person | patient |
| Procedure | patient, performer |
| Provenance | patient |
| QuestionnaireResponse | subject, author |
| RelatedPerson | patient |
| RequestGroup | subject, participant |
| ResearchSubject | individual |
| RiskAssessment | subject |
| Schedule | actor |
| ServiceRequest | subject, performer |
| Specimen | subject |
| SupplyDelivery | patient |
| SupplyRequest | subject |
| 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 | recorder, asserter |
| Appointment | actor |
| AppointmentResponse | actor |
| AuditEvent | agent |
| Basic | author |
| CarePlan | performer |
| CareTeam | participant |
| ChargeItem | enterer, performer-actor |
| Claim | enterer, provider, payee, care-team |
| ClaimResponse | requestor |
| ClinicalImpression | assessor |
| Communication | sender, recipient |
| CommunicationRequest | sender, recipient, requester |
| Composition | subject, author, attester |
| Condition | asserter |
| CoverageEligibilityRequest | enterer, provider |
| CoverageEligibilityResponse | requestor |
| DetectedIssue | author |
| DeviceRequest | requester, performer |
| DiagnosticReport | performer |
| DocumentManifest | subject, author, recipient |
| DocumentReference | subject, author, authenticator |
| Encounter | practitioner, participant |
| EpisodeOfCare | care-manager |
| ExplanationOfBenefit | enterer, provider, payee, care-team |
| Flag | author |
| Group | member |
| Immunization | performer |
| Invoice | participant |
| Linkage | author |
| List | source |
| Media | subject, operator |
| MedicationAdministration | performer |
| MedicationDispense | performer, receiver |
| MedicationRequest | requester |
| MedicationStatement | source |
| MessageHeader | receiver, author, responsible, enterer |
| NutritionOrder | provider |
| Observation | performer |
| Patient | general-practitioner |
| PaymentNotice | provider |
| PaymentReconciliation | requestor |
| Person | practitioner |
| Practitioner | {def} |
| PractitionerRole | practitioner |
| Procedure | performer |
| Provenance | agent |
| QuestionnaireResponse | author, source |
| RequestGroup | participant, author |
| ResearchStudy | principalinvestigator |
| 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 | asserter |
| Appointment | actor |
| AppointmentResponse | actor |
| Basic | author |
| CarePlan | performer |
| CareTeam | participant |
| ChargeItem | enterer, performer-actor |
| Claim | payee |
| Communication | sender, recipient |
| CommunicationRequest | sender, recipient, requester |
| Composition | author |
| Condition | asserter |
| Coverage | policy-holder, subscriber, payor |
| DocumentManifest | author, recipient |
| DocumentReference | author |
| Encounter | participant |
| ExplanationOfBenefit | payee |
| Invoice | recipient |
| MedicationAdministration | performer |
| MedicationStatement | source |
| Observation | performer |
| Patient | link |
| Person | link |
| Procedure | performer |
| Provenance | agent |
| QuestionnaireResponse | author, source |
| RelatedPerson | {def} |
| RequestGroup | 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\nOPERATION: Apply
The official URL for this operation definition is:
http://hl7.org/fhir/OperationDefinition/ActivityDefinition-apply
The apply operation applies a definition in a specific context
\nURL: [base]/ActivityDefinition/$apply
URL: [base]/ActivityDefinition/[id]/$apply
Parameters
| Use | Name | Cardinality | Type | Binding | Documentation |
| IN | activityDefinition | 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 | Any | 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
\nOPERATION: Data Requirements
The official URL for this operation definition is:
http://hl7.org/fhir/OperationDefinition/ActivityDefinition-data-requirements
The data-requirements operation aggregates and returns the parameters and data requirements for the activity definition and all its dependencies as a single module definition library
\nURL: [base]/ActivityDefinition/[id]/$data-requirements
Parameters
| Use | Name | 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)
\nOPERATION: Test if a server implements a client's required operations
The official URL for this operation definition is:
http://hl7.org/fhir/OperationDefinition/CapabilityStatement-conforms
This operation asks the server to check that it implements all the resources, interactions, search parameters, and operations that the client provides in its capability statement. The client provides both capability statements by reference, and must ensure that all the referenced resources are available to the conformance server
\nURL: [base]/CapabilityStatement/$conforms
Parameters
| Use | Name | 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
\nOPERATION: Test if a server implements a client's required operations
The official URL for this operation definition is:
http://hl7.org/fhir/OperationDefinition/CapabilityStatement-implements
This operation asks the server to check that it implements all the resources, interactions, search parameters, and operations that the client provides in its capability statement. The client provides its capability statement inline, or by referring the server to the canonical URL of its capability statement
\nURL: [base]/CapabilityStatement/$implements
URL: [base]/CapabilityStatement/[id]/$implements
Parameters
| Use | Name | 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
\nOPERATION: Fetch a subset of the CapabilityStatement resource
The official URL for this operation definition is:
http://hl7.org/fhir/OperationDefinition/CapabilityStatement-subset
This operation asks the server to return a subset of the CapabilityStatement resource - just the REST parts that relate to a set of nominated resources - the resources that the client is interested in
\nURL: [base]/CapabilityStatement/$subset
URL: [base]/CapabilityStatement/[id]/$subset
Parameters
| Use | Name | Cardinality | Type | Binding | Documentation |
| IN | server | 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 |
OPERATION: Discover what versions a server supports
The official URL for this operation definition is:
http://hl7.org/fhir/OperationDefinition/CapabilityStatement-versions
Using the FHIR Version Mime Type Parameter, a server can support multiple versions on the same end-point. The only way for client to find out what versions a server supports in this fashion is the $versions operation. The client invokes the operation with no parameters. and the server returns the list of supported versions, along with the default version it will use if no fhirVersion parameter is present
\nURL: [base]/$versions
Parameters
| Use | Name | 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 | The default version for the server. Use the major.minor version like 3.0 \n |
OPERATION: Apply
The official URL for this operation definition is:
http://hl7.org/fhir/OperationDefinition/ChargeItemDefinition-apply
The apply operation applies a definition in a specific context
\nURL: [base]/ChargeItemDefinition/[id]/$apply
Parameters
| Use | Name | 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 | Any | 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. For a more detailed description, refer to the ActivityDefinition resource
\nOPERATION: Submit a Claim resource for adjudication
The official URL for this operation definition is:
http://hl7.org/fhir/OperationDefinition/Claim-submit
This operation is used to submit a Claim, Pre-Authorization or Pre-Determination (all instances of Claim resources) for adjudication either as a single Claim resource instance or as a Bundle containing the Claim and other referenced resources, or Bundle containing a batch of Claim resources, either as single Claims resources or Bundle resources, for processing. The only input parameter is the single Claim or Bundle resource and the only output is a single ClaimResponse, Bundle of ClaimResponses or an OperationOutcome resource.
\nURL: [base]/Claim/$submit
Parameters
| Use | Name | 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 |
OPERATION: Finding codes based on supplied properties
The official URL for this operation definition is:
http://hl7.org/fhir/OperationDefinition/CodeSystem-find-matches
Given a set of properties (and text), return one or more possible matching codes
\nThis operation takes a set of properties, and examines the code system looking for codes in the code system that match a set of known properties.
\nWhen looking for matches, there are 3 possible types of match:
\nThe $find-matches operation can be called in one of 2 modes:
\nThese modes are differentiated by the 'exact' parameter, so the client can indicate whether it only wants exact matches (including partial matches) or whether potential matches based on text matching are desired
\nThe find-matches operation is still preliminary. The interface can be expected to change as more experience is gained from implementations.
\nURL: [base]/CodeSystem/$find-matches
URL: [base]/CodeSystem/[id]/$find-matches
Parameters
| Use | Name | Cardinality | Type | Binding | Documentation |
| IN | system | 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 | 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 | code | Coding | string | integer | boolean | dateTime | 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 | code | Coding | string | integer | boolean | dateTime | 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 | code | Coding | string | integer | boolean | dateTime | 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 | code | Coding | string | integer | boolean | dateTime | 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 |
OPERATION: Concept Look Up & Decomposition
The official URL for this operation definition is:
http://hl7.org/fhir/OperationDefinition/CodeSystem-lookup
Given a code/system, or a Coding, get additional details about the concept, including definition, status, designations, and properties. One of the products of this operation is a full decomposition of a code from a structured terminology.
\nWhen invoking this operation, a client SHALL provide both a system and a code, either using the system+code parameters, or in the coding parameter. Other parameters are optional
\nURL: [base]/CodeSystem/$lookup
Parameters
| Use | Name | 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 | 0..1 | uri | The system for the code that is to be located \n | |
| IN | version | 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 $expand.displayLanguage) \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: url, name, version (code system info) and code information: display, definition, designation, parent and child, and for designations, lang.X where X is a designation language code. Some of the properties are returned explicit in named parameters (when the names match), and the rest (except for lang.X) in the property parameter group \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 | 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.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 | code | Coding | string | integer | boolean | dateTime | decimal | 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.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 | code | Coding | string | integer | boolean | dateTime | decimal | The value of the sub-property returned \n | |
| OUT | property.subproperty.description | 0..1 | string | Human Readable representation of the property value (e.g. display for a code) \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.
\nOPERATION: Subsumption Testing
The official URL for this operation definition is:
http://hl7.org/fhir/OperationDefinition/CodeSystem-subsumes
Test the subsumption relationship between code/Coding A and code/Coding B given the semantics of subsumption in the underlying code system (see hierarchyMeaning).
\nWhen invoking this operation, a client SHALL provide both a and codes, either as code or Coding parameters. The system parameter is required unless the operation is invoked on an instance of a code system resource. Other parameters are optional
\nURL: [base]/CodeSystem/$subsumes
URL: [base]/CodeSystem/[id]/$subsumes
Parameters
| Use | Name | 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 | 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 | 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 | http://hl7.org/fhir/ValueSet/concept-subsumption-outcome|4.0.1 (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 |
OPERATION: Code System based Validation
The official URL for this operation definition is:
http://hl7.org/fhir/OperationDefinition/CodeSystem-validate-code
Validate that a coded value is in the code system. If the operation is not called at the instance level, one of the parameters "url" or "codeSystem" must be provided. The operation returns a result (true / false), an error message, and the recommended display for the code.
\nWhen invoking this operation, a client SHALL provide one (and only one) of the parameters (code+system, coding, or codeableConcept). Other parameters (including version and display) are optional
\nURL: [base]/CodeSystem/$validate-code
URL: [base]/CodeSystem/[id]/$validate-code
Parameters
| Use | Name | Cardinality | Type | Binding | Documentation |
| IN | url | 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 | 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 | 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 |
OPERATION: Generate a Document
The official URL for this operation definition is:
http://hl7.org/fhir/OperationDefinition/Composition-document
A client can ask a server to generate a fully bundled document from a composition resource. The server takes the composition resource, locates all the referenced resources and other additional resources as configured or requested and either returns a full document bundle, or returns an error. Note that since this is a search operation, the document bundle is wrapped inside the search bundle. If some of the resources are located on other servers, it is at the discretion of the server whether to retrieve them or return an error. If the correct version of the document that would be generated already exists, then the server can return the existing one.
\nURL: [base]/Composition/$document
URL: [base]/Composition/[id]/$document
Parameters
| Use | Name | Cardinality | Type | Binding | Documentation |
| IN | id | 0..1 | uri | Identifies the composition to use. This can either be a simple id, which identifies a composition, or it can be a full URL, which identifies a composition on another server. \nNotes: \n
| |
| 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, it's 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 |
Note: this operation definition does not resolve the question how document signatures are created. This is an open issue during the period of trial use, and feedback is requested regarding this question
\nOPERATION: Closure Table Maintenance
The official URL for this operation definition is:
http://hl7.org/fhir/OperationDefinition/ConceptMap-closure
This operation provides support for ongoing maintenance of a client-side transitive closure table based on server-side terminological logic. For details of how this is used, see Maintaining a Closure Table
\nURL: [base]/$closure
Parameters
| Use | Name | 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 equivalences that can be returned are equal, specializes, subsumes and unmatched \n |
OPERATION: Concept Translation
The official URL for this operation definition is:
http://hl7.org/fhir/OperationDefinition/ConceptMap-translate
Translate a code from one value set to another, based on the existing value set and concept maps resources, and/or other additional knowledge available to the server.
\nOne (and only one) of the in parameters (code, coding, codeableConcept) must be provided, to identify the code that is to be translated.
\nThe operation returns a set of parameters including a 'result' for whether there is an acceptable match, and a list of possible matches. Note that the list of matches may include notes of codes for which mapping is specifically excluded, so implementers have to check the match.equivalence for each match
\nURL: [base]/ConceptMap/$translate
URL: [base]/ConceptMap/[id]/$translate
Parameters
| Use | Name | Cardinality | Type | Binding | Documentation |
| IN | url | 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 | 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 | 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 | code | 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 | source | 0..1 | uri | Identifies the value set used when the concept (system/code pair) was chosen. May be a logical id, or an absolute or relative location. The source value set is an optional parameter because in some cases, the client cannot know what the source value set is. However, without a source value set, the server may be unable to safely identify an applicable concept map, and would return an error. For this reason, a source value set SHOULD always be provided. Note that servers may be able to identify an appropriate concept map without a source value set if there is a full mapping for the entire code system in the concept map, or by manual intervention \n | |
| IN | coding | 0..1 | Coding | A coding to translate \n | |
| IN | codeableConcept | 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 | target | 0..1 | uri | Identifies the value set in which a translation is sought. May be a logical id, or an absolute or relative location. If there's no target specified, the server should return all known translations, along with their source \n | |
| IN | targetsystem | 0..1 | uri | identifies a target code system in which a mapping is sought. This parameter is an alternative to the target 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..* | Another element that may help produce the correct mapping \n | ||
| IN | dependency.element | 0..1 | uri | The element for this dependency \n | |
| IN | dependency.concept | 0..1 | CodeableConcept | The value for this dependency \n | |
| IN | reverse | 0..1 | boolean | if this is true, then the operation should return all the codes that might be mapped to this code. This parameter reverses the meaning of the source and target parameters \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 an equivalence which is not unmatched or disjoint \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 an equivalence. Note that there may be multiple matches of equal or differing equivalence, and the matches may include equivalence values that mean that there is no match \n | ||
| OUT | match.equivalence | 0..1 | code | A code indicating the equivalence of the translation, using values from ConceptMapEquivalence \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.product | 0..* | Another element that is the product of this mapping \n | ||
| OUT | match.product.element | 0..1 | uri | The element for this product \n | |
| OUT | match.product.concept | 0..1 | Coding | The value for this product \n | |
| OUT | match.source | 0..1 | uri | The canonical reference to the concept map from which this mapping comes from \n |
OPERATION: Submit an EligibilityRequest resource for assessment
The official URL for this operation definition is:
http://hl7.org/fhir/OperationDefinition/CoverageEligibilityRequest-submit
This operation is used to submit an EligibilityRequest for assessment either as a single EligibilityRequest resource instance or as a Bundle containing the EligibilityRequest and other referenced resources, or Bundle containing a batch of EligibilityRequest resources, either as single EligibilityRequests resources or Bundle resources, for processing. The only input parameter is the single EligibilityRequest or Bundle resource and the only output is a single EligibilityResponse, Bundle of EligibilityResponses or an OperationOutcome resource.
\nURL: [base]/CoverageEligibilityRequest/$submit
Parameters
| Use | Name | 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 |
OPERATION: Fetch Encounter Record
The official URL for this operation definition is:
http://hl7.org/fhir/OperationDefinition/Encounter-everything
This operation is used to return all the information related to an encounter described in the resource on which this operation is invoked. The response is a bundle of type "searchset". At a minimum, the encounter resource itself is returned, along with any other resources that the server has available for the given encounter for the user. The server also returns whatever resources are needed to support the records - e.g. linked practitioners, locations, organizations etc. The principle intended use for this operation is to provide a patient with access to their record, or to allow a client to retrieve everything for an encounter for efficient display).
\nThe server SHOULD return all resources it has that:
\nIn the US Realm, at a mimimum, the resources returned SHALL include all the data covered by the meaningful use common data elements (see DAF for further guidance). Other applicable implementation guides may make additional rules about the information that is returned. Note that for many resources, the exact nature of the link to encounter can be ambiguous (e.g. for a DiagnosticReport, is it the encounter when it was initiated, or when it was reported?)
\nURL: [base]/Encounter/[id]/$everything
Parameters
| Use | Name | 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 /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.
\nOPERATION: Fetch a group of Patient Records
The official URL for this operation definition is:
http://hl7.org/fhir/OperationDefinition/Group-everything
This operation is used to return all the information related to one or more patients that are part of the group on which this operation is invoked. The response is a bundle of type "searchset". At a minimum, the patient resource(s) itself is returned, along with any other resources that the server has that are related to the patient(s), and that are available for the given user. The server also returns whatever resources are needed to support the records - e.g. linked practitioners, medications, locations, organizations etc. The intended use for this operation is for a provider or other user to perform a bulk data download. The server SHOULD return at least all resources that it has that are in the patient compartment for the identified patient(s), and any resource referenced from those, including binaries and attachments. In the US Realm, at a mimimum, the resources returned SHALL include all the data covered by the meaningful use common data elements as defined in US-Core. Other applicable implementation guides may make additional rules about how much information that is returned.
\nURL: [base]/Group/[id]/$everything
Parameters
| Use | Name | 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 /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.
\nOPERATION: Data Requirements
The official URL for this operation definition is:
http://hl7.org/fhir/OperationDefinition/Library-data-requirements
The data-requirements operation aggregates and returns the parameters and data requirements for a resource and all its dependencies as a single module definition
\nURL: [base]/$data-requirements
URL: [base]/Library/[id]/$data-requirements
Parameters
| Use | Name | 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)
\nOPERATION: Find a functional list
The official URL for this operation definition is:
http://hl7.org/fhir/OperationDefinition/List-find
This operation allows a client to find an identified list for a particular function by its function. The operation takes two parameters, the identity of a patient, and the name of a functional list. The list of defined functional lists can be found at Current Resource Lists. Applications are not required to support all the lists, and may define additional lists of their own. If the system is able to locate a list that serves the identified purpose, it returns it as the body of the response with a 200 OK status. If the resource cannot be located, the server returns a 404 not found (optionally with an OperationOutcome resource)
\nURL: [base]/List/$find
Parameters
| Use | Name | 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
\nOPERATION: Care Gaps
The official URL for this operation definition is:
http://hl7.org/fhir/OperationDefinition/Measure-care-gaps
The care-gaps operation is used to determine gaps-in-care based on the results of quality measures
\nURL: [base]/Measure/$care-gaps
Parameters
| Use | Name | 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
\nOPERATION: Collect Data
The official URL for this operation definition is:
http://hl7.org/fhir/OperationDefinition/Measure-collect-data
The collect-data operation is used to collect the data-of-interest for the given measure.
\nURL: [base]/Measure/$collect-data
URL: [base]/Measure/[id]/$collect-data
Parameters
| Use | Name | 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 | 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-collection 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
\nOPERATION: Data Requirements
The official URL for this operation definition is:
http://hl7.org/fhir/OperationDefinition/Measure-data-requirements
The data-requirements operation aggregates and returns the parameters and data requirements for the measure and all its dependencies as a single module definition
\nURL: [base]/Measure/[id]/$data-requirements
Parameters
| Use | Name | 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
\nOPERATION: Evaluate Measure
The official URL for this operation definition is:
http://hl7.org/fhir/OperationDefinition/Measure-evaluate-measure
The evaluate-measure operation is used to calculate an eMeasure and obtain the results
\nURL: [base]/Measure/$evaluate-measure
URL: [base]/Measure/[id]/$evaluate-measure
Parameters
| Use | Name | 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 | |
| IN | measure | 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 | reportType | 0..1 | code | The type of measure report: subject, subject-list, or population. If not specified, a default value of subject will be used if the subject parameter is supplied, otherwise, population will be used \n | |
| IN | subject | 0..1 | string (reference) | Subject for which the measure will be calculated. If not specified, the measure will be calculated 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 calculated. If specified, the measure will be calculated 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 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 | |
| OUT | return | 1..1 | MeasureReport | The results of the measure 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, or all subjects if no subject is supplied, and return the results as a MeasureReport resource of the appropriate type. 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
\nOPERATION: Submit Data
The official URL for this operation definition is:
http://hl7.org/fhir/OperationDefinition/Measure-submit-data
The submit-data operation is used to submit data-of-interest for a measure. There is no expectation that the submitted data represents all the data-of-interest, only that all the data submitted is relevant to the calculation of the measure for a particular subject or population
\nURL: [base]/Measure/$submit-data
URL: [base]/Measure/[id]/$submit-data
Parameters
| Use | Name | 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
\nOPERATION: Fetch Product Record
The official URL for this operation definition is:
http://hl7.org/fhir/OperationDefinition/MedicinalProduct-everything
This operation is used to return all the information related to one or more products described in the resource or context on which this operation is invoked. The response is a bundle of type "searchset". At a minimum, the product resource(s) itself is returned, along with any other resources that the server has that are related to the products(s), and that are available for the given user. This is typically the marketing authorisations, ingredients, packages, therapeutic indications and so on. The server also returns whatever resources are needed to support the records - e.g. linked organizations, document references etc.
\nURL: [base]/MedicinalProduct/$everything
URL: [base]/MedicinalProduct/[id]/$everything
Parameters
| Use | Name | 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.
\nOPERATION: Process Message
The official URL for this operation definition is:
http://hl7.org/fhir/OperationDefinition/MessageHeader-process-message
This operation accepts a message, processes it according to the definition of the event in the message header, and returns one or more response messages.
\nIn addition to processing the message event, a server may choose to retain all or some the resources and make them available on a RESTful interface, but is not required to do so.
\nURL: [base]/$process-message
Parameters
| Use | Name | 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:
\nOPERATION: Fetch Preferred it
The official URL for this operation definition is:
http://hl7.org/fhir/OperationDefinition/NamingSystem-preferred-id
This operation returns the preferred identifiers for identifiers, and terminologies. The operation takes 2 parameters:
\nand returns either the requested identifier, or an HTTP errors response with an OperationOutcome because either the provided identifier was not recognized, or the requested identiifer type is not known.
\nThe principle use of this operation is when converting between v2, CDA and FHIR Identifier/CX/II and CodeableConcepts/C(N/W)E/CD but the operation may also find use when converting metadata such as profiles.
\nURL: [base]/NamingSystem/$preferred-id
Parameters
| Use | Name | Cardinality | Type | Binding | Documentation |
| IN | id | 1..1 | string | The server parses the provided id to see what type it is (mary 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 | http://hl7.org/fhir/ValueSet/namingsystem-identifier-type|4.0.1 (Required) | |
| 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 are multiple possible identifiers of the specified type (e.g. multiple OIDs) the server returns an error.
\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
\nOPERATION: Last N Observations Query
The official URL for this operation definition is:
http://hl7.org/fhir/OperationDefinition/Observation-lastn
The lastn query meets the common need for searching for the most recent or last n=number of observations for a subject. For example, retrieving the last 5 temperatures for a patient to view trends or fetching the most recent laboratory results or vitals signs. To ask a server to return the last n=number of observations, the lastn query uses the normal search parameters defined for the Observation resource. However, rather than their normal use, they are interpreted as inputs - i.e.. instead of requiring that the resources literally contain the search parameters, they are passed to a server algorithm of some kind that uses them to determine the most appropriate matches.
\nThe request for a lastn query SHALL include:
\n$lastn operation parameterpatient or subject search parametercategory parameter and/or a search parameter that contains a code element in its FHIRpath expression. ( e.g., code or code-value-concept)The request for a lastn query MAY include:
\nThe response from a lastn query is a set of observations:
\nObservation.code\ncoding.value and coding.system are the same.for example:
\n| Observation.code for observation a | Observation.code for observation b | Observation.code for observation c | number of groups [codes/text in each group] |
|---|---|---|---|
| a | b | c | 3 [a],[b],[c] |
| a | b | a,c | 2 [a.c],[b] |
| a | b | a,b | 1 [a,b] |
| 'textM' | 'Text' | 't e x t' | 3 ['text'],['Text'],['t e x t'] |
The set of returned observations should represent distinct real world observations and not the same observation with changes in status or versions. If there are no matches, the lastn query SHALL return an empty search set with no error, but may include an operation outcome with further advice.
\nURL: [base]/Observation/$lastn
Parameters
| Use | Name | 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.
\nOPERATION: Observation Statistics
The official URL for this operation definition is:
http://hl7.org/fhir/OperationDefinition/Observation-stats
The Statistics operation performs a set of statistical calculations on a set of clinical measurements such as a blood pressure as stored on the server. This operation evaluates Observation resources having valueQuantity elements that have UCUM unit codes. Observations with a status of 'entered-in-error' will be excluded from the calculations.
\nThe set of Observations is defined by 4 parameters:
\nsubject)code and system, or coding)orperiod`)statistic)Possible statistical analyses (see StatisticsCode):
\nIf successful, the operation returns an Observation resource for each code with the results of the statistical calculations as component value pairs where the component code = the statistical code. The Observation also contains the input parameters patient,code and duration parameters. If unsuccessful, an OperationOutcome with an error message will be returned.
The client can request that all the observations on which the statistics are based be returned as well, using the include parameter. If an include parameter is specified, a limit may also be specified; the sources observations are subsetted at the server's discretion if count > limit. This functionality is included with the intent of supporting graphical presentation
\nURL: [base]/Observation/$stats
Parameters
| Use | Name | 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 | 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 paramter 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.
\nOPERATION: Fetch Patient Record
The official URL for this operation definition is:
http://hl7.org/fhir/OperationDefinition/Patient-everything
This operation is used to return all the information related to one or more patients described in the resource or context on which this operation is invoked. The response is a bundle of type "searchset". At a minimum, the patient resource(s) itself is returned, along with any other resources that the server has that are related to the patient(s), and that are available for the given user. The server also returns whatever resources are needed to support the records - e.g. linked practitioners, medications, locations, organizations etc.
\nThe intended use for this operation is to provide a patient with access to their entire record (e.g. "Blue Button"), or for provider or other user to perform a bulk data download. The server SHOULD return at least all resources that it has that are in the patient compartment for the identified patient(s), and any resource referenced from those, including binaries and attachments. In the US Realm, at a minimum, the resources returned SHALL include all the data covered by the meaningful use common data elements as defined in the US Core Implementation Guide. Other applicable implementation guides may make additional rules about how much information that is returned.
\nURL: [base]/Patient/$everything
URL: [base]/Patient/[id]/$everything
Parameters
| Use | Name | 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 /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.
\nOPERATION: Find patient matches using MPI based logic
The official URL for this operation definition is:
http://hl7.org/fhir/OperationDefinition/Patient-match
A Master Patient Index (MPI ) is a service used to manage patient identification in a context where multiple patient databases exist. Healthcare applications and middleware use the MPI to match patients between the databases, and to store new patient details as they are encountered. MPIs are highly specialized applications, often tailored extensively to the institution's particular mix of patients. MPIs can also be run on a regional and national basis.
\nTo ask an MPI to match a patient, clients use the "$match" operation, which accepts a patient resource which may be only partially complete. The data provided is interpreted as an MPI input and processed by an algorithm of some kind that uses the data to determine the most appropriate matches in the patient set. Note that different MPI matching algorithms have different required inputs. The generic $match operation does not specify any particular algorithm, nor a minimum set of information that must be provided when asking for an MPI match operation to be performed, but many implementations will have a set of minimum information, which may be declared in their definition of the $match operation by specifying a profile on the resource parameter, indicating which properties are required in the search. The patient resource submitted to the operation does not have to be complete, nor does it need to pass validation (i.e. mandatory fields don't need to be populated), but it does have to be a valid instance, as it is used as the reference data to match against.
\nURL: [base]/Patient/$match
Parameters
| Use | Name | 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 | A 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 "match-grade" that indicates the MPI's position on the match quality.
\nOPERATION: Apply
The official URL for this operation definition is:
http://hl7.org/fhir/OperationDefinition/PlanDefinition-apply
The apply operation applies a PlanDefinition to a given context
\nURL: [base]/PlanDefinition/$apply
URL: [base]/PlanDefinition/[id]/$apply
Parameters
| Use | Name | Cardinality | Type | Binding | Documentation |
| IN | planDefinition | 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 \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 | 1..1 | CarePlan | The CarePlan that is the result of applying the plan definition \n |
The result of this operation is a CarePlan resource with a single activity represented by a RequestGroup. The RequestGroup 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 activity to the CarePlan. 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
\nOPERATION: Data Requirements
The official URL for this operation definition is:
http://hl7.org/fhir/OperationDefinition/PlanDefinition-data-requirements
The data-requirements operation aggregates and returns the parameters and data requirements for the plan definition and all its dependencies as a single module definition library
\nURL: [base]/PlanDefinition/[id]/$data-requirements
Parameters
| Use | Name | 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)
\nOPERATION: Convert from one form to another
The official URL for this operation definition is:
http://hl7.org/fhir/OperationDefinition/Resource-convert
This operation takes a resource in one form, and returns to in another form. Both input and output are a single resource. The primary use of this operation is to convert between formats (e.g. (XML -> JSON or vice versa)
\nURL: [base]/$convert
Parameters
| Use | Name | Cardinality | Type | Binding | Documentation |
| IN | input | 1..1 | Resource | The resource that is to be converted \n | |
| OUT | output | 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:
\nImplementers are encouraged to provide feedback to HL7 about their use of this operation
\nOPERATION: Return a graph of resources
The official URL for this operation definition is:
http://hl7.org/fhir/OperationDefinition/Resource-graph
Return an entire graph of resources based on a GraphDefinition. The operation is invoked on a specific instance of a resource, and the graph definition tells the server what other resources to return in the same packaage
\nURL: [base]/Resource/[id]/$graph
Parameters
| Use | Name | 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 |
OPERATION: Execute a graphql statement
The official URL for this operation definition is:
http://hl7.org/fhir/OperationDefinition/Resource-graphql
Execute a graphql statement on a since resource or against the entire system. See the Using GraphQL with FHIR page for further details.
\nFor the purposes of graphQL compatibility, this operation can also be invoked using a POST with the graphQL as the body, or a JSON body (see graphQL spec for details)
\nURL: [base]/$graphql
URL: [base]/Resource/[id]/$graphql
Parameters
| Use | Name | 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 |
OPERATION: Access a list of profiles, tags, and security labels
The official URL for this operation definition is:
http://hl7.org/fhir/OperationDefinition/Resource-meta
This operation retrieves a summary of the profiles, tags, and security labels for the given scope; e.g. for each scope:
\nURL: [base]/$meta
URL: [base]/Resource/$meta
URL: [base]/Resource/[id]/$meta
Parameters
| Use | Name | 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
\nOPERATION: Add profiles, tags, and security labels to a resource
The official URL for this operation definition is:
http://hl7.org/fhir/OperationDefinition/Resource-meta-add
This operation takes a meta, and adds the profiles, tags, and security labels found in it to the nominated resource
\nURL: [base]/Resource/[id]/$meta-add
Parameters
| Use | Name | 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 |
OPERATION: Delete profiles, tags, and security labels for a resource
The official URL for this operation definition is:
http://hl7.org/fhir/OperationDefinition/Resource-meta-delete
This operation takes a meta, and deletes the profiles, tags, and security labels found in it from the nominated resource
\nURL: [base]/Resource/[id]/$meta-delete
Parameters
| Use | Name | 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 |
OPERATION: Validate a resource
The official URL for this operation definition is:
http://hl7.org/fhir/OperationDefinition/Resource-validate
The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter:
\nModes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an OperationOutcome
\nNote that this operation is not the only way to validate resources - see Validating Resources for further information.
\nURL: [base]/Resource/$validate
URL: [base]/Resource/[id]/$validate
Parameters
| Use | Name | Cardinality | Type | Binding | Documentation |
| IN | resource | 0..1 | Resource | Must be present unless the mode is "delete" \n | |
| IN | mode | 0..1 | code | http://hl7.org/fhir/ValueSet/resource-validation-mode|4.0.1 (Required) | Default is 'no action'; (e.g. general validation) \n |
| IN | profile | 0..1 | uri | 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 | |
| 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 whether or not the resource is valid. A 4xx or 5xx error means that the validation itself could not be performed, and it is unknown whether the resource is valid or not.
\nNote: the correct behaviour 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
\nOPERATION: Build Questionnaire
The official URL for this operation definition is:
http://hl7.org/fhir/OperationDefinition/StructureDefinition-questionnaire
Generates a Questionnaire instance based on a specified StructureDefinition, creating questions for each core element or extension element found in the StructureDefinition.
\nIf the operation is not called at the instance level, one of the identifier, profile or url 'in' parameters must be provided. If more than one is specified, servers may raise an error or may resolve with the parameter of their choice. If called at the instance level, these parameters will be ignored. The response will contain a Questionnaire instance based on the specified StructureDefinition and/or an OperationOutcome resource with errors or warnings. Nested groups are used to handle complex structures and data types. If the 'supportedOnly' parameter is set to true, only those elements marked as "must support" will be included.
\nThis operation is intended to enable auto-generation of simple interfaces for arbitrary profiles. The 'questionnaire' approach to data entry has limitations that will make it less optimal than custom-defined interfaces. However, this function may be useful for simple applications or for systems that wish to support "non-core" resources with minimal development effort.
\nURL: [base]/StructureDefinition/$questionnaire
URL: [base]/StructureDefinition/[id]/$questionnaire
Parameters
| Use | Name | Cardinality | Type | Binding | Documentation |
| IN | identifier | 0..1 | canonical | 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 | string (token) | The StructureDefinition is provided directly as part of the request. Servers may choose not to accept profiles in this fashion \n | |
| IN | url | 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.
\nOPERATION: Generate Snapshot
The official URL for this operation definition is:
http://hl7.org/fhir/OperationDefinition/StructureDefinition-snapshot
Generates a StructureDefinition instance with a snapshot, based on a differential in a specified StructureDefinition.
\nIf the operation is not called at the instance level, either definition or url 'in' parameters must be provided. If more than one is specified, servers may raise an error or may resolve with the parameter of their choice. If called at the instance level, these parameters will be ignored.
\nURL: [base]/StructureDefinition/$snapshot
URL: [base]/StructureDefinition/[id]/$snapshot
Parameters
| Use | Name | Cardinality | Type | Binding | Documentation |
| IN | definition | 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 | 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 |
OPERATION: Model Instance Transformation
The official URL for this operation definition is:
http://hl7.org/fhir/OperationDefinition/StructureMap-transform
The transform operation takes input content, applies a structure map transform, and then returns the output.
\nURL: [base]/StructureMap/$transform
URL: [base]/StructureMap/[id]/$transform
Parameters
| Use | Name | Cardinality | Type | Binding | Documentation |
| IN | source | 0..1 | uri | The structure map to apply. This is only needed if the operation is invoked at the resource level. If the $transform operation is invoked on a particular structure map, this will be ignored by the server \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
\nOPERATION: Value Set Expansion
The official URL for this operation definition is:
http://hl7.org/fhir/OperationDefinition/ValueSet-expand
The definition of a value set is used to create a simple collection of codes suitable for use for data entry or validation.
\nIf the operation is not called at the instance level, one of the in parameters url, context or valueSet must be provided. An expanded value set will be returned, or an OperationOutcome with an error message.
\nURL: [base]/ValueSet/$expand
URL: [base]/ValueSet/[id]/$expand
Parameters
| Use | Name | Cardinality | Type | Binding | Documentation |
| IN | url | 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 | 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 | 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 | excludeNested | 0..1 | boolean | Controls whether or not the value set expansion nests codes or not (i.e. ValueSet.expansion.contains.contains) \n | |
| IN | excludeNotForUI | 0..1 | boolean | Controls whether or not the value set expansion is assembled for a user interface use or not. Value sets intended for User Interface might include 'abstract' codes or have nested contains with items with no code or abstract = true, with the sole purpose of helping a user navigate through the list efficiently, where as a value set not generated for UI use might be flat, and only contain the selectable codes in the value set. The exact implications of 'for UI' depend on the code system, and what properties it exposes for a terminology server to use. In the FHIR Specification itself, the value set expansions are generated with excludeNotForUI = false, and the expansions used when generated 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 | 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.
\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
\nOPERATION: Value Set based Validation
The official URL for this operation definition is:
http://hl7.org/fhir/OperationDefinition/ValueSet-validate-code
Validate that a coded value is in the set of codes allowed by a value set.
\nIf the operation is not called at the instance level, one of the in parameters url, context or valueSet must be provided. One (and only one) of the in parameters code, coding, or codeableConcept must be provided. The operation returns a result (true / false), an error message, and the recommended display for the code
\nURL: [base]/ValueSet/$validate-code
URL: [base]/ValueSet/[id]/$validate-code
Parameters
| Use | Name | Cardinality | Type | Binding | Documentation |
| IN | url | 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 | 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 | 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, 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 |
Note: the correct behaviour 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![\"doco\"](\"help16.png\") |
|---|---|---|---|---|
| N | n/a | Base Resource | ||
| Σ | 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 Common Languages (Preferred but limited to AllLanguages) | ||
| Documentation for this format |
| 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 AccountStatus (Required) | |
| Σ | 0..1 | CodeableConcept | E.g. patient, expense, depreciation 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 | string | 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 | ||
| 0..1 | Reference(Account) | Reference to a parent Account | ||
| Documentation for this format |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ITU | 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 | ||
| Σ | 0..1 | uri | Canonical identifier for this activity definition, represented as a URI (globally unique) | |
| Σ | 0..* | Identifier | Additional identifier for the activity definition | |
| Σ | 0..1 | string | Business version of the activity definition | |
| ΣI | 0..1 | string | Name for this activity definition (computer friendly) | |
| Σ | 0..1 | string | Name for this activity definition (human friendly) | |
| 0..1 | string | Subordinate title of the activity definition | ||
| ?!Σ | 1..1 | code | draft | active | retired | unknown PublicationStatus (Required) | |
| Σ | 0..1 | boolean | For testing purposes, not real usage | |
| 0..1 | Type of individual the activity definition is intended for Subject type (Extensible) | |||
| CodeableConcept | ||||
| Reference(Group) | ||||
| Σ | 0..1 | dateTime | Date last changed | |
| Σ | 0..1 | string | Name of the publisher (organization or individual) | |
| Σ | 0..* | ContactDetail | Contact details for the publisher | |
| Σ | 0..1 | markdown | Natural language description of the activity definition | |
| Σ | 0..* | UsageContext | The context that the content is intended to support | |
| Σ | 0..* | CodeableConcept | Intended jurisdiction for activity definition (if applicable) Jurisdiction (Extensible) | |
| 0..1 | markdown | Why this activity definition is defined | ||
| 0..1 | string | Describes the clinical usage of the activity definition | ||
| 0..1 | markdown | Use and/or publishing restrictions | ||
| 0..1 | date | When the activity definition was approved by publisher | ||
| 0..1 | date | When the activity definition was last reviewed | ||
| Σ | 0..1 | Period | When the activity definition is expected to be used | |
| 0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc. DefinitionTopic (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 RequestResourceType (Required) | |
| 0..1 | canonical(StructureDefinition) | What profile the resource needs to conform to | ||
| Σ | 0..1 | CodeableConcept | Detail type of activity Procedure Codes (SNOMED CT) (Example) | |
| 0..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option RequestIntent (Required) | ||
| 0..1 | code | routine | urgent | asap | stat Request priority (Required) | ||
| ?!Σ | 0..1 | boolean | True if the activity should not be performed | |
| 0..1 | When activity is to occur | |||
| Timing | ||||
| dateTime | ||||
| Age | ||||
| Period | ||||
| Range | ||||
| Duration | ||||
| 0..1 | Reference(Location) | Where it should happen | ||
| 0..* | BackboneElement | Who should participate in the action | ||
| 1..1 | code | patient | practitioner | related-person | device ActionParticipantType (Required) | ||
| 0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent, etc. Action participant role (Example) | ||
| 0..1 | What's administered/supplied SNOMED CT Medication Codes (Example) | |||
| Reference(Medication | Substance) | ||||
| CodeableConcept | ||||
| 0..1 | SimpleQuantity | How much is administered/consumed/supplied | ||
| 0..* | Dosage | Detailed dosage instructions | ||
| 0..* | CodeableConcept | What part of body to perform on SNOMED CT Body Structures (Example) | ||
| 0..* | Reference(SpecimenDefinition) | What specimens are required to perform this action | ||
| 0..* | Reference(ObservationDefinition) | What observations are required to perform this action | ||
| 0..* | Reference(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 | ||
| Documentation for this format |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ΣTU | DomainResource | Medical care, research study or other healthcare event causing physical injury Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| Σ | 0..1 | Identifier | Business identifier for the event | |
| ?!Σ | 1..1 | code | actual | potential AdverseEventActuality (Required) | |
| Σ | 0..* | CodeableConcept | product-problem | product-quality | product-use-error | wrong-dose | incorrect-prescribing-information | wrong-technique | wrong-route-of-administration | wrong-rate | wrong-duration | wrong-time | expired-drug | medical-device-use-error | problem-different-manufacturer | unsafe-physical-environment AdverseEventCategory (Extensible) | |
| Σ | 0..1 | CodeableConcept | Type of the event itself in relation to the subject SNOMED CT Clinical Findings (Example) | |
| Σ | 1..1 | Reference(Patient | Group | Practitioner | RelatedPerson) | Subject impacted by event | |
| Σ | 0..1 | Reference(Encounter) | Encounter created as part of | |
| Σ | 0..1 | dateTime | When the event occurred | |
| Σ | 0..1 | dateTime | When the event was detected | |
| Σ | 0..1 | dateTime | When the event was recorded | |
| Σ | 0..* | Reference(Condition) | Effect on the subject due to this event | |
| Σ | 0..1 | Reference(Location) | Location where adverse event occurred | |
| Σ | 0..1 | CodeableConcept | Seriousness of the event AdverseEventSeriousness (Example) | |
| Σ | 0..1 | CodeableConcept | mild | moderate | severe AdverseEventSeverity (Required) | |
| Σ | 0..1 | CodeableConcept | resolved | recovering | ongoing | resolvedWithSequelae | fatal | unknown AdverseEventOutcome (Required) | |
| Σ | 0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson) | Who recorded the adverse event | |
| Σ | 0..* | Reference(Practitioner | PractitionerRole | Device) | Who was involved in the adverse event or the potential adverse event | |
| Σ | 0..* | BackboneElement | The suspected agent causing the adverse event | |
| Σ | 1..1 | Reference(Immunization | Procedure | Substance | Medication | MedicationAdministration | MedicationStatement | Device) | Refers to the specific entity that caused the adverse event | |
| Σ | 0..* | BackboneElement | Information on the possible cause of the event | |
| Σ | 0..1 | CodeableConcept | Assessment of if the entity caused the event AdverseEventCausalityAssessment (Example) | |
| Σ | 0..1 | string | AdverseEvent.suspectEntity.causalityProductRelatedness | |
| Σ | 0..1 | Reference(Practitioner | PractitionerRole) | AdverseEvent.suspectEntity.causalityAuthor | |
| Σ | 0..1 | CodeableConcept | ProbabilityScale | Bayesian | Checklist AdverseEventCausalityMethod (Example) | |
| Σ | 0..* | Reference(Condition | Observation | AllergyIntolerance | FamilyMemberHistory | Immunization | Procedure | Media | DocumentReference) | AdverseEvent.subjectMedicalHistory | |
| Σ | 0..* | Reference(DocumentReference) | AdverseEvent.referenceDocument | |
| Σ | 0..* | Reference(ResearchStudy) | AdverseEvent.study | |
| Documentation for this format |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ITU | DomainResource | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) + Rule: AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. + Rule: AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| Σ | 0..* | Identifier | External ids for this item | |
| ?!ΣI | 0..1 | CodeableConcept | active | inactive | resolved AllergyIntolerance Clinical Status Codes (Required) | |
| ?!ΣI | 0..1 | CodeableConcept | unconfirmed | confirmed | refuted | entered-in-error AllergyIntolerance Verification Status Codes (Required) | |
| Σ | 0..1 | code | allergy | intolerance - Underlying mechanism (if known) AllergyIntoleranceType (Required) | |
| Σ | 0..* | code | food | medication | environment | biologic AllergyIntoleranceCategory (Required) | |
| Σ | 0..1 | code | low | high | unable-to-assess AllergyIntoleranceCriticality (Required) | |
| Σ | 0..1 | CodeableConcept | Code that identifies the allergy or intolerance AllergyIntolerance Substance/Product, Condition and Negation Codes (Example) | |
| Σ | 1..1 | Reference(Patient) | Who the sensitivity 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 first version of the resource instance was recorded | ||
| 0..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) | Who recorded the sensitivity | ||
| Σ | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) | Source of the information about the allergy | |
| 0..1 | dateTime | Date(/time) of last known occurrence of a reaction | ||
| 0..* | Annotation | Additional text not captured in other fields | ||
| 0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance | ||
| 0..1 | CodeableConcept | Specific substance or pharmaceutical product considered to be responsible for event Substance Code (Example) | ||
| 1..* | CodeableConcept | Clinical symptoms/signs associated with the Event 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) AllergyIntoleranceSeverity (Required) | ||
| 0..1 | CodeableConcept | How the subject was exposed to the substance SNOMED CT Route Codes (Example) | ||
| 0..* | Annotation | Text about event not captured in other fields | ||
| Documentation for this format |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ITU | 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: Cancelation reason is only used for appointments that have been cancelled, or no-show Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| Σ | 0..* | Identifier | External Ids for this item | |
| ?!Σ | 1..1 | code | proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist AppointmentStatus (Required) | |
| Σ | 0..1 | CodeableConcept | The coded reason for the appointment being cancelled Appointment cancellation reason (Example) | |
| Σ | 0..* | CodeableConcept | A broad categorization of the service that is to be performed during this appointment Service category (Example) | |
| Σ | 0..* | CodeableConcept | The specific service that is to be performed during this appointment Service type (Example) | |
| Σ | 0..* | CodeableConcept | The specialty of a practitioner that would be required to perform the service requested in this appointment 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) v2 Appointment Reason Codes (Preferred) | |
| Σ | 0..* | CodeableConcept | Coded reason this appointment is scheduled Encounter Reason Codes (Preferred) | |
| 0..* | Reference(Condition | Procedure | Observation | ImmunizationRecommendation) | Reason the appointment is to take place (resource) | ||
| 0..1 | unsignedInt | Used to make informed decisions if needing to re-prioritize | ||
| 0..1 | string | Shown on a subject line in a meeting request, or appointment list | ||
| 0..* | Reference(Any) | Additional information to support the appointment | ||
| Σ | 0..1 | instant | When appointment is to take place | |
| Σ | 0..1 | instant | When appointment is to conclude | |
| 0..1 | positiveInt | Can be less than start/end (e.g. estimate) | ||
| 0..* | Reference(Slot) | The slots that this appointment is filling | ||
| 0..1 | dateTime | The date that this appointment was initially created | ||
| 0..1 | string | Additional comments | ||
| 0..1 | string | Detailed information and instructions for the patient | ||
| 0..* | Reference(ServiceRequest) | The service request this appointment is allocated to assess | ||
| I | 1..* | BackboneElement | Participants involved in appointment + Rule: Either the type or actor on the participant SHALL be specified | |
| Σ | 0..* | CodeableConcept | Role of participant in the appointment Participant type (Extensible) | |
| Σ | 0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location) | Person, Location/HealthcareService or Device | |
| Σ | 0..1 | code | required | optional | information-only ParticipantRequired (Required) | |
| Σ | 1..1 | code | accepted | declined | tentative | needs-action ParticipationStatus (Required) | |
| 0..1 | Period | Participation period of the actor | ||
| 0..* | Period | Potential date/time interval(s) requested to allocate the appointment within | ||
| Documentation for this format |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ITU | 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 | instant | Time from appointment, or requested new start time | ||
| 0..1 | instant | Time from appointment, or requested new end time | ||
| Σ | 0..* | CodeableConcept | Role of participant in the appointment Participant type (Extensible) | |
| Σ | 0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location) | Person, Location, HealthcareService, or Device | |
| ?!Σ | 1..1 | code | accepted | declined | tentative | needs-action ParticipationStatus (Required) | |
| 0..1 | string | Additional comments | ||
| Documentation for this format |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | Event record kept for security purposes Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| Σ | 1..1 | Coding | Type/identifier of event Audit Event ID (Extensible) | |
| Σ | 0..* | Coding | More specific type/id for the event Audit Event Sub-Type (Extensible) | |
| Σ | 0..1 | code | Type of action performed during the event AuditEventAction (Required) | |
| 0..1 | Period | When the activity occurred | ||
| Σ | 1..1 | instant | Time when the event was recorded | |
| Σ | 0..1 | code | Whether the event succeeded or failed AuditEventOutcome (Required) | |
| Σ | 0..1 | string | Description of the event outcome | |
| Σ | 0..* | CodeableConcept | The purposeOfUse of the event V3 Value SetPurposeOfUse (Extensible) | |
| 1..* | BackboneElement | Actor involved in the event | ||
| 0..1 | CodeableConcept | How agent participated ParticipationRoleType (Extensible) | ||
| 0..* | CodeableConcept | Agent role in the event SecurityRoleType (Example) | ||
| Σ | 0..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | Identifier of who | |
| 0..1 | string | Alternative User identity | ||
| 0..1 | string | Human friendly name for the agent | ||
| Σ | 1..1 | boolean | Whether user is initiator | |
| 0..1 | Reference(Location) | Where | ||
| 0..* | uri | Policy that authorized event | ||
| 0..1 | Coding | Type of media Media Type Code (Extensible) | ||
| 0..1 | BackboneElement | Logical network location for application activity | ||
| 0..1 | string | Identifier for the network access point of the user device | ||
| 0..1 | code | The type of network access point AuditEventAgentNetworkType (Required) | ||
| 0..* | CodeableConcept | Reason given for this user V3 Value SetPurposeOfUse (Extensible) | ||
| 1..1 | BackboneElement | Audit Event Reporter | ||
| 0..1 | string | Logical source location within the enterprise | ||
| Σ | 1..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | The identity of source detecting the event | |
| 0..* | Coding | The type of source where event originated Audit Event Source Type (Extensible) | ||
| I | 0..* | BackboneElement | Data or objects used + Rule: Either a name or a query (NOT both) | |
| Σ | 0..1 | Reference(Any) | Specific instance of resource | |
| 0..1 | Coding | Type of entity involved Audit event entity type (Extensible) | ||
| 0..1 | Coding | What role the entity played AuditEventEntityRole (Extensible) | ||
| 0..1 | Coding | Life-cycle stage for the entity ObjectLifecycleEvents (Extensible) | ||
| 0..* | Coding | Security labels on the entity SecurityLabels (Extensible) | ||
| ΣI | 0..1 | string | Descriptor for entity | |
| 0..1 | string | Descriptive text | ||
| ΣI | 0..1 | base64Binary | Query parameters | |
| 0..* | BackboneElement | Additional Information about the entity | ||
| 1..1 | string | Name of the property | ||
| 1..1 | Property value | |||
| string | ||||
| base64Binary | ||||
| Documentation for this format |
| 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 Basic Resource Types (Example) | |
| Σ | 0..1 | Reference(Any) | Identifies the focus of this resource | |
| Σ | 0..1 | date | When created | |
| Σ | 0..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson | Organization) | Who created | |
| Documentation for this format |
| 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 MimeType (Required) | |
| Σ | 0..1 | Reference(Any) | Identifies another resource to use as proxy when enforcing access control | |
| 0..1 | base64Binary | The actual content | ||
| Documentation for this format |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | A material substance originating from a biological entity Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| Σ | 0..* | Identifier | External ids for this item | |
| 0..1 | code | organ | tissue | fluid | cells | biologicalAgent BiologicallyDerivedProductCategory (Required) | ||
| 0..1 | CodeableConcept | What this biologically derived product is | ||
| 0..1 | code | available | unavailable BiologicallyDerivedProductStatus (Required) | ||
| 0..* | Reference(ServiceRequest) | Procedure request | ||
| 0..1 | integer | The amount of this biologically derived product | ||
| 0..* | Reference(BiologicallyDerivedProduct) | BiologicallyDerivedProduct parent | ||
| 0..1 | BackboneElement | How this product was collected | ||
| 0..1 | Reference(Practitioner | PractitionerRole) | Individual performing collection | ||
| 0..1 | Reference(Patient | Organization) | Who is product from | ||
| 0..1 | Time of product collection | |||
| dateTime | ||||
| Period | ||||
| 0..* | BackboneElement | Any processing of the product during collection | ||
| 0..1 | string | Description of of processing | ||
| 0..1 | CodeableConcept | Procesing code Procedure Codes (SNOMED CT) (Example) | ||
| 0..1 | Reference(Substance) | Substance added during processing | ||
| 0..1 | Time of processing | |||
| dateTime | ||||
| Period | ||||
| 0..1 | BackboneElement | Any manipulation of product post-collection | ||
| 0..1 | string | Description of manipulation | ||
| 0..1 | Time of manipulation | |||
| dateTime | ||||
| Period | ||||
| 0..* | BackboneElement | Product storage | ||
| 0..1 | string | Description of storage | ||
| 0..1 | decimal | Storage temperature | ||
| 0..1 | code | farenheit | celsius | kelvin BiologicallyDerivedProductStorageScale (Required) | ||
| 0..1 | Period | Storage timeperiod | ||
| Documentation for this format |
| 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 SNOMED CT Morphologic Abnormalities (Example) | |
| Σ | 0..1 | CodeableConcept | Body site SNOMED CT Body Structures (Example) | |
| 0..* | CodeableConcept | Body site modifier Bodystructure Location Qualifier (Example) | ||
| Σ | 0..1 | string | Text description | |
| 0..* | Attachment | Attached images | ||
| Σ | 1..1 | Reference(Patient) | Who this is about | |
| Documentation for this format |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ΣIN | Resource | Contains a collection of resources + Rule: total only when a search or history + Rule: entry.search only when a search + Rule: entry.request mandatory for batch/transaction/history, otherwise prohibited + Rule: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited + 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 Elements defined in Ancestors: id, meta, implicitRules, language | ||
| Σ | 0..1 | Identifier | Persistent identifier for the bundle | |
| Σ | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection BundleType (Required) | |
| Σ | 0..1 | instant | When the bundle was assembled | |
| ΣI | 0..1 | unsignedInt | If search, the total number of matches | |
| Σ | 0..* | BackboneElement | Links related to this Bundle | |
| Σ | 1..1 | string | See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1 | |
| Σ | 1..1 | uri | Reference details for the link | |
| ΣI | 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 | |
| Σ | 0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | |
| Σ | 0..1 | Resource | A resource in the bundle | |
| ΣI | 0..1 | BackboneElement | Search related information | |
| Σ | 0..1 | code | match | include | outcome - why this is in the result set SearchEntryMode (Required) | |
| Σ | 0..1 | decimal | Search ranking (between 0 and 1) | |
| ΣI | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) | |
| Σ | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH HTTPVerb (Required) | |
| Σ | 1..1 | uri | URL for HTTP equivalent of this entry | |
| Σ | 0..1 | string | For managing cache currency | |
| Σ | 0..1 | instant | For managing cache currency | |
| Σ | 0..1 | string | For managing update contention | |
| Σ | 0..1 | string | For conditional creates | |
| ΣI | 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 | |
| Documentation for this format |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| IN | 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 required (and is only permitted) when a statement is for an implementation. + 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 | ||
| Σ | 0..1 | uri | Canonical identifier for this capability statement, represented as a URI (globally unique) | |
| Σ | 0..1 | string | Business version of the capability statement | |
| ΣI | 0..1 | string | Name for this capability statement (computer friendly) | |
| Σ | 0..1 | string | Name for this capability statement (human friendly) | |
| ?!Σ | 1..1 | code | draft | active | retired | unknown PublicationStatus (Required) | |
| Σ | 0..1 | boolean | For testing purposes, not real usage | |
| Σ | 1..1 | dateTime | Date last changed | |
| Σ | 0..1 | string | Name of the publisher (organization or individual) | |
| Σ | 0..* | ContactDetail | Contact details for the publisher | |
| I | 0..1 | markdown | Natural language description of the capability statement | |
| ΣTU | 0..* | UsageContext | The context that the content is intended to support | |
| Σ | 0..* | CodeableConcept | Intended jurisdiction for capability statement (if applicable) Jurisdiction (Extensible) | |
| 0..1 | markdown | Why this capability statement is defined | ||
| 0..1 | markdown | Use and/or publishing restrictions | ||
| ΣI | 1..1 | code | instance | capability | requirements CapabilityStatementKind (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 | |
| ΣI | 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 | |
| ΣI | 0..1 | BackboneElement | If this describes a specific instance | |
| Σ | 1..1 | string | 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 FHIRVersion (Required) | |
| Σ | 1..* | code | formats supported (xml | json | ttl | mime type) MimeType (Required) | |
| Σ | 0..* | code | Patch formats supported MimeType (Required) | |
| Σ | 0..* | canonical(ImplementationGuide) | Implementation guides supported | |
| ΣI | 0..* | BackboneElement | If the endpoint is a RESTful one + Rule: A given resource can only be described once per RESTful mode. | |
| Σ | 1..1 | code | client | server RestfulCapabilityMode (Required) | |
| 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 RestfulSecurityService (Extensible) | |
| 0..1 | markdown | General description of how security works | ||
| ΣI | 0..* | BackboneElement | Resource served on the REST interface + Rule: Search parameter names must be unique in the context of a resource. | |
| Σ | 1..1 | code | A resource type that is supported ResourceType (Required) | |
| Σ | 0..1 | canonical(StructureDefinition) | Base System profile for all uses of resource | |
| ΣTU | 0..* | canonical(StructureDefinition) | Profiles for use cases supported | |
| 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 TypeRestfulInteraction (Required) | ||
| 0..1 | markdown | Anything special about operation behavior | ||
| TU | 0..1 | code | no-version | versioned | versioned-update ResourceVersionPolicy (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 ConditionalReadStatus (Required) | |
| TU | 0..1 | boolean | If allows/uses conditional update | |
| TU | 0..1 | code | not-supported | single | multiple - how conditional delete is supported ConditionalDeleteStatus (Required) | |
| TU | 0..* | code | literal | logical | resolves | enforced | local ReferenceHandlingPolicy (Required) | |
| TU | 0..* | string | _include values supported by the server | |
| TU | 0..* | string | _revinclude values supported by the server | |
| 0..* | BackboneElement | Search parameters supported by implementation | ||
| 1..1 | string | Name of search parameter | ||
| 0..1 | canonical(SearchParameter) | Source of definition for parameter | ||
| 1..1 | code | number | date | string | token | reference | composite | quantity | uri | special 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 | |
| 0..1 | markdown | Specific details about operation behavior | ||
| 0..* | BackboneElement | What operations are supported? | ||
| 1..1 | code | transaction | batch | search-system | history-system SystemRestfulInteraction (Required) | ||
| 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 | ||
| ΣITU | 0..* | BackboneElement | If messaging is supported | |
| 0..* | BackboneElement | Where messages should be sent | ||
| 1..1 | Coding | http | ftp | mllp + MessageTransport (Extensible) | ||
| 1..1 | url | Network address or identifier of the end-point | ||
| 0..1 | unsignedInt | Reliable Message Cache Length (min) | ||
| 0..1 | markdown | Messaging interface behavior details | ||
| Σ | 0..* | BackboneElement | Messages supported by this system | |
| Σ | 1..1 | code | sender | receiver EventCapabilityMode (Required) | |
| Σ | 1..1 | canonical(MessageDefinition) | Message supported by this system | |
| ΣITU | 0..* | BackboneElement | Document definition | |
| Σ | 1..1 | code | producer | consumer DocumentMode (Required) | |
| 0..1 | markdown | Description of document support | ||
| Σ | 1..1 | canonical(StructureDefinition) | Constraint on the resources used in the document | |
| Documentation for this format |
| 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) | Fulfills CarePlan | |
| Σ | 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 RequestStatus (Required) | |
| ?!Σ | 1..1 | code | proposal | plan | order | option Care Plan Intent (Required) | |
| Σ | 0..* | CodeableConcept | Type of plan 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) | Encounter created as part of | |
| Σ | 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..* | Reference(Condition) | Health issues this plan addresses | |
| 0..* | Reference(Any) | Information considered as part of plan | ||
| 0..* | Reference(Goal) | Desired outcome of plan | ||
| I | 0..* | BackboneElement | Action to occur as part of plan + Rule: Provide a reference or detail, not both | |
| 0..* | CodeableConcept | Results of the activity Care Plan Activity Outcome (Example) | ||
| 0..* | Reference(Any) | Appointment, Encounter, Procedure, etc. | ||
| 0..* | Annotation | Comments about the activity status/progress | ||
| I | 0..1 | Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | RequestGroup) | Activity details defined in specific resource | |
| I | 0..1 | BackboneElement | In-line definition of activity | |
| 0..1 | code | Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription Care Plan Activity Kind (Required) | ||
| 0..* | canonical(PlanDefinition | ActivityDefinition | Questionnaire | Measure | OperationDefinition) | Instantiates FHIR protocol or definition | ||
| 0..* | uri | Instantiates external protocol or definition | ||
| 0..1 | CodeableConcept | Detail type of activity Procedure Codes (SNOMED CT) (Example) | ||
| 0..* | CodeableConcept | Why activity should be done or why activity was prohibited SNOMED CT Clinical Findings (Example) | ||
| 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Why activity is needed | ||
| 0..* | Reference(Goal) | Goals this activity relates to | ||
| ?! | 1..1 | code | not-started | scheduled | in-progress | on-hold | completed | cancelled | stopped | unknown | entered-in-error CarePlanActivityStatus (Required) | |
| 0..1 | CodeableConcept | Reason for current status | ||
| ?! | 0..1 | boolean | If true, activity is prohibiting action | |
| 0..1 | When activity is to occur | |||
| Timing | ||||
| Period | ||||
| string | ||||
| 0..1 | Reference(Location) | Where it should happen | ||
| 0..* | Reference(Practitioner | PractitionerRole | Organization | RelatedPerson | Patient | CareTeam | HealthcareService | Device) | Who will be responsible? | ||
| 0..1 | What is to be administered/supplied SNOMED CT Medication Codes (Example) | |||
| CodeableConcept | ||||
| Reference(Medication | Substance) | ||||
| 0..1 | SimpleQuantity | How to consume/day? | ||
| 0..1 | SimpleQuantity | How much to administer/supply/consume | ||
| 0..1 | string | Extra info describing activity to perform | ||
| 0..* | Annotation | Comments about the plan | ||
| Documentation for this format |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | Planned participants in the coordination and delivery of care for a patient or group 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 CareTeamStatus (Required) | |
| Σ | 0..* | CodeableConcept | Type of team 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 | Reference(Encounter) | Encounter created as part of | |
| Σ | 0..1 | Period | Time period team covers | |
| I | 0..* | BackboneElement | Members of the team + Rule: CareTeam.participant.onBehalfOf can only be populated when CareTeam.participant.member is a Practitioner | |
| Σ | 0..* | CodeableConcept | Type of involvement Participant Roles (Example) | |
| Σ | 0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Organization | CareTeam) | Who is involved | |
| Σ | 0..1 | Reference(Organization) | Organization of the practitioner | |
| 0..1 | Period | Time period of participant | ||
| 0..* | CodeableConcept | Why the care team exists SNOMED CT Clinical Findings (Example) | ||
| 0..* | Reference(Condition) | Why the care team exists | ||
| Σ | 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 | ||
| Documentation for this format |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | An entry in a catalog Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| Σ | 0..* | Identifier | Unique identifier of the catalog item | |
| 0..1 | CodeableConcept | The type of item - medication, device, service, protocol or other | ||
| Σ | 1..1 | boolean | Whether the entry represents an orderable item | |
| Σ | 1..1 | Reference(Medication | Device | Organization | Practitioner | PractitionerRole | HealthcareService | ActivityDefinition | PlanDefinition | SpecimenDefinition | ObservationDefinition | Binary) | The item that is being defined | |
| 0..* | Identifier | Any additional identifier(s) for the catalog item, in the same granularity or concept | ||
| 0..* | CodeableConcept | Classification (category or class) of the item entry | ||
| 0..1 | code | draft | active | retired | unknown PublicationStatus (Required) | ||
| 0..1 | Period | The time period in which this catalog entry is expected to be active | ||
| 0..1 | dateTime | The date until which this catalog entry is expected to be active | ||
| 0..1 | dateTime | When was this catalog last updated | ||
| 0..* | CodeableConcept | Additional characteristics of the catalog entry | ||
| 0..* | CodeableConcept | Additional classification of the catalog entry | ||
| 0..* | BackboneElement | An item that this catalog entry is related to | ||
| 1..1 | code | triggers | is-replaced-by CatalogEntryRelationType (Required) | ||
| 1..1 | Reference(CatalogEntry) | The reference to the related item | ||
| Documentation for this format |
| 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 ChargeItemStatus (Required) | |
| 0..* | Reference(ChargeItem) | Part of referenced ChargeItem | ||
| Σ | 1..1 | CodeableConcept | A code that identifies the charge, like a billing code ChargeItemCode (Example) | |
| Σ | 1..1 | Reference(Patient | Group) | Individual service was done for/to | |
| Σ | 0..1 | Reference(Encounter | EpisodeOfCare) | Encounter / Episode associated with event | |
| Σ | 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 Procedure Performer Role Codes (Example) | ||
| 1..1 | Reference(Practitioner | PractitionerRole | Organization | 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 SNOMED CT Body Structures (Example) | |
| 0..1 | decimal | Factor overriding the associated rules | ||
| 0..1 | Money | Price overriding the associated rules | ||
| 0..1 | string | Reason for overriding the list price/factor | ||
| Σ | 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? ICD-10 Codes (Example) | ||
| 0..* | Reference(DiagnosticReport | ImagingStudy | Immunization | MedicationAdministration | MedicationDispense | Observation | Procedure | SupplyDelivery) | Which rendered service is being charged? | ||
| 0..1 | Product charged FHIR Device Types (Example) | |||
| Reference(Device | Medication | Substance) | ||||
| CodeableConcept | ||||
| Σ | 0..* | Reference(Account) | Account to place this charge | |
| 0..* | Annotation | Comments made about the ChargeItem | ||
| 0..* | Reference(Any) | Further information supporting this charge | ||
| Documentation for this format |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ITU | 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 | ||
| Σ | 1..1 | uri | Canonical identifier for this charge item definition, represented as a URI (globally unique) | |
| Σ | 0..* | Identifier | Additional identifier for the charge item definition | |
| Σ | 0..1 | string | Business version of the charge item definition | |
| Σ | 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 PublicationStatus (Required) | |
| Σ | 0..1 | boolean | For testing purposes, not real usage | |
| Σ | 0..1 | dateTime | Date last changed | |
| Σ | 0..1 | string | Name of the publisher (organization or individual) | |
| Σ | 0..* | ContactDetail | Contact details for the publisher | |
| Σ | 0..1 | markdown | Natural language description of the charge item definition | |
| Σ | 0..* | UsageContext | The context that the content is intended to support | |
| Σ | 0..* | CodeableConcept | Intended jurisdiction for charge item definition (if applicable) Jurisdiction (Extensible) | |
| 0..1 | markdown | Use and/or publishing restrictions | ||
| 0..1 | date | When the charge item definition was approved by publisher | ||
| 0..1 | date | When the charge item definition was last reviewed | ||
| Σ | 0..1 | Period | When the charge item definition is expected to be used | |
| Σ | 0..1 | CodeableConcept | Billing codes or product types this definition applies to ChargeItemCode (Example) | |
| 0..* | Reference(Medication | Substance | Device) | Instances this definition applies to | ||
| 0..* | BackboneElement | Whether or not the billing code is applicable | ||
| 0..1 | string | Natural language description of the condition | ||
| 0..1 | string | Language of the expression | ||
| 0..1 | string | Boolean-valued expression | ||
| 0..* | BackboneElement | Group of properties which are applicable under the same conditions | ||
| 0..* | see applicability | Conditions under which the priceComponent is applicable | ||
| 0..* | BackboneElement | Components of total line item price | ||
| 1..1 | code | base | surcharge | deduction | discount | tax | informational InvoicePriceComponentType (Required) | ||
| 0..1 | CodeableConcept | Code identifying the specific component | ||
| 0..1 | decimal | Factor used for calculating this component | ||
| 0..1 | Money | Monetary amount associated with this component | ||
| Documentation for this format |
| 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 | ||
| ?!Σ | 1..1 | code | active | cancelled | draft | entered-in-error Financial Resource Status Codes (Required) | |
| Σ | 1..1 | CodeableConcept | Category or discipline Claim Type Codes (Extensible) | |
| 0..1 | CodeableConcept | More granular claim type Example Claim SubType Codes (Example) | ||
| Σ | 1..1 | code | claim | preauthorization | predetermination 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) | Author of the claim | ||
| Σ | 0..1 | Reference(Organization) | Target | |
| Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Party responsible for the claim | |
| Σ | 1..1 | CodeableConcept | Desired processing ugency Process Priority Codes (Example) | |
| 0..1 | CodeableConcept | For whom to reserve funds FundsReserve (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 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 PayeeType (Example) | ||
| 0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson) | Recipient reference | ||
| 0..1 | Reference(ServiceRequest) | Treatment referral | ||
| 0..1 | Reference(Location) | Servicing facility | ||
| 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 Claim Care Team Role Codes (Example) | ||
| 0..1 | CodeableConcept | Practitioner credential or specialization Example Provider Qualification Codes (Example) | ||
| 0..* | BackboneElement | Supporting information | ||
| 1..1 | positiveInt | Information instance identifier | ||
| 1..1 | CodeableConcept | Classification of the supplied information Claim Information Category Codes (Example) | ||
| 0..1 | CodeableConcept | Type of information Exception Codes (Example) | ||
| 0..1 | When it occurred | |||
| date | ||||
| Period | ||||
| 0..1 | Data to be provided | |||
| boolean | ||||
| string | ||||
| Quantity | ||||
| Attachment | ||||
| Reference(Any) | ||||
| 0..1 | CodeableConcept | Explanation for the information Missing Tooth Reason Codes (Example) | ||
| 0..* | BackboneElement | Pertinent diagnosis information | ||
| 1..1 | positiveInt | Diagnosis instance identifier | ||
| 1..1 | Nature of illness or problem ICD-10 Codes (Example) | |||
| CodeableConcept | ||||
| Reference(Condition) | ||||
| 0..* | CodeableConcept | Timing or nature of the diagnosis Example Diagnosis Type Codes (Example) | ||
| 0..1 | CodeableConcept | Present on admission Example Diagnosis on Admission Codes (Example) | ||
| 0..1 | CodeableConcept | Package billing code Example Diagnosis Related Group Codes (Example) | ||
| 0..* | BackboneElement | Clinical procedures performed | ||
| 1..1 | positiveInt | Procedure instance identifier | ||
| 0..* | CodeableConcept | Category of Procedure Example Procedure Type Codes (Example) | ||
| 0..1 | dateTime | When the procedure was performed | ||
| 1..1 | Specific clinical procedure ICD-10 Procedure Codes (Example) | |||
| CodeableConcept | ||||
| Reference(Procedure) | ||||
| 0..* | Reference(Device) | Unique device identifier | ||
| Σ | 1..* | 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 V3 Value SetActIncidentCode (Extensible) | ||
| 0..1 | Where the event occurred | |||
| Address | ||||
| Reference(Location) | ||||
| 0..* | BackboneElement | Product or service provided | ||
| 1..1 | positiveInt | Item instance identifier | ||
| 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 Example Revenue Center Codes (Example) | ||
| 0..1 | CodeableConcept | Benefit classification Benefit Category Codes (Example) | ||
| 1..1 | CodeableConcept | Billing, service, product, or drug code USCLS Codes (Example) | ||
| 0..* | CodeableConcept | Product or service billing modifiers Modifier type Codes (Example) | ||
| 0..* | CodeableConcept | Program the product or service is provided under 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 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 item cost | ||
| 0..* | Reference(Device) | Unique device identifier | ||
| 0..1 | CodeableConcept | Anatomical location Oral Site Codes (Example) | ||
| 0..* | CodeableConcept | Anatomical sub-location Surface Codes (Example) | ||
| 0..* | Reference(Encounter) | Encounters related to this billed item | ||
| 0..* | BackboneElement | Product or service provided | ||
| 1..1 | positiveInt | Item instance identifier | ||
| 0..1 | CodeableConcept | Revenue or cost center code Example Revenue Center Codes (Example) | ||
| 0..1 | CodeableConcept | Benefit classification Benefit Category Codes (Example) | ||
| 1..1 | CodeableConcept | Billing, service, product, or drug code USCLS Codes (Example) | ||
| 0..* | CodeableConcept | Service/Product billing modifiers Modifier type Codes (Example) | ||
| 0..* | CodeableConcept | Program the product or service is provided under Example Program Reason 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 item cost | ||
| 0..* | Reference(Device) | Unique device identifier | ||
| 0..* | BackboneElement | Product or service provided | ||
| 1..1 | positiveInt | Item instance identifier | ||
| 0..1 | CodeableConcept | Revenue or cost center code Example Revenue Center Codes (Example) | ||
| 0..1 | CodeableConcept | Benefit classification Benefit Category Codes (Example) | ||
| 1..1 | CodeableConcept | Billing, service, product, or drug code USCLS Codes (Example) | ||
| 0..* | CodeableConcept | Service/Product billing modifiers Modifier type Codes (Example) | ||
| 0..* | CodeableConcept | Program the product or service is provided under Example Program Reason 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 item cost | ||
| 0..* | Reference(Device) | Unique device identifier | ||
| 0..1 | Money | Total claim cost | ||
| Documentation for this format |
| 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 | ||
| ?!Σ | 1..1 | code | active | cancelled | draft | entered-in-error Financial Resource Status Codes (Required) | |
| Σ | 1..1 | CodeableConcept | More granular claim type Claim Type Codes (Extensible) | |
| 0..1 | CodeableConcept | More granular claim type Example Claim SubType Codes (Example) | ||
| Σ | 1..1 | code | claim | preauthorization | predetermination Use (Required) | |
| Σ | 1..1 | Reference(Patient) | The recipient of the products and services | |
| Σ | 1..1 | dateTime | Response creation date | |
| Σ | 1..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 Claim Processing Codes (Required) | |
| 0..1 | string | Disposition Message | ||
| 0..1 | string | Preauthorization reference | ||
| 0..1 | Period | Preauthorization reference effective period | ||
| 0..1 | CodeableConcept | Party to be paid any benefits payable PayeeType (Example) | ||
| 0..* | BackboneElement | Adjudication for claim line items | ||
| 1..1 | positiveInt | Claim item instance identifier | ||
| 0..* | positiveInt | Applicable note numbers | ||
| 1..* | BackboneElement | Adjudication details | ||
| 1..1 | CodeableConcept | Type of adjudication information Adjudication Value Codes (Example) | ||
| 0..1 | CodeableConcept | Explanation of adjudication outcome Adjudication Reason Codes (Example) | ||
| 0..1 | Money | Monetary amount | ||
| 0..1 | decimal | Non-monetary value | ||
| 0..* | BackboneElement | Adjudication for claim details | ||
| 1..1 | positiveInt | Claim detail instance identifier | ||
| 0..* | positiveInt | Applicable note numbers | ||
| 1..* | see adjudication | Detail level adjudication details | ||
| 0..* | BackboneElement | Adjudication for claim sub-details | ||
| 1..1 | positiveInt | Claim sub-detail instance identifier | ||
| 0..* | positiveInt | Applicable note numbers | ||
| 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..* | Reference(Practitioner | PractitionerRole | Organization) | Authorized providers | ||
| 1..1 | CodeableConcept | Billing, service, product, or drug code USCLS Codes (Example) | ||
| 0..* | CodeableConcept | Service/Product billing modifiers Modifier type Codes (Example) | ||
| 0..* | CodeableConcept | Program the product or service is provided under 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 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 item cost | ||
| 0..1 | CodeableConcept | Anatomical location Oral Site Codes (Example) | ||
| 0..* | CodeableConcept | Anatomical sub-location Surface Codes (Example) | ||
| 0..* | positiveInt | Applicable note numbers | ||
| 1..* | see adjudication | Added items adjudication | ||
| 0..* | BackboneElement | Insurer added line details | ||
| 1..1 | CodeableConcept | Billing, service, product, or drug code USCLS Codes (Example) | ||
| 0..* | CodeableConcept | Service/Product billing modifiers 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 item cost | ||
| 0..* | positiveInt | Applicable note numbers | ||
| 1..* | see adjudication | Added items detail adjudication | ||
| 0..* | BackboneElement | Insurer added line items | ||
| 1..1 | CodeableConcept | Billing, service, product, or drug code USCLS Codes (Example) | ||
| 0..* | CodeableConcept | Service/Product billing modifiers 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 item cost | ||
| 0..* | positiveInt | Applicable note numbers | ||
| 1..* | see adjudication | Added items detail adjudication | ||
| 0..* | see adjudication | Header-level adjudication | ||
| Σ | 0..* | BackboneElement | Adjudication totals | |
| Σ | 1..1 | CodeableConcept | Type of adjudication information Adjudication Value Codes (Example) | |
| Σ | 1..1 | Money | Financial total for the category | |
| 0..1 | BackboneElement | Payment Details | ||
| 1..1 | CodeableConcept | Partial or complete payment Example Payment Type Codes (Example) | ||
| 0..1 | Money | Payment adjustment for non-claim issues | ||
| 0..1 | CodeableConcept | Explanation for the adjustment 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 FundsReserve (Example) | ||
| 0..1 | CodeableConcept | Printed form identifier Forms (Example) | ||
| 0..1 | Attachment | Printed reference or actual form | ||
| 0..* | BackboneElement | Note concerning adjudication | ||
| 0..1 | positiveInt | Note instance identifier | ||
| 0..1 | code | display | print | printoper NoteType (Required) | ||
| 1..1 | string | Note explanatory text | ||
| 0..1 | CodeableConcept | Language of the text Common Languages (Preferred but limited to AllLanguages) | ||
| 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 AdjudicationError (Example) | ||
| Documentation for this format |
| 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 | in-progress | completed | entered-in-error Clinical Impression Status (Required) | |
| 0..1 | CodeableConcept | Reason for current status | ||
| Σ | 0..1 | CodeableConcept | Kind of assessment performed | |
| Σ | 0..1 | string | Why/how the assessment was performed | |
| Σ | 1..1 | Reference(Patient | Group) | Patient or group assessed | |
| Σ | 0..1 | Reference(Encounter) | Encounter created as part of | |
| Σ | 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..* | BackboneElement | One or more sets of investigations (signs, symptoms, etc.) | ||
| 1..1 | CodeableConcept | A name/code for the set Investigation Type (Example) | ||
| 0..* | Reference(Observation | QuestionnaireResponse | FamilyMemberHistory | DiagnosticReport | RiskAssessment | ImagingStudy | Media) | Record of a specific investigation | ||
| 0..* | uri | Clinical Protocol followed | ||
| 0..1 | string | Summary of the assessment | ||
| 0..* | BackboneElement | Possible or likely findings and diagnoses | ||
| 0..1 | CodeableConcept | What was found Condition/Problem/Diagnosis Codes (Example) | ||
| 0..1 | Reference(Condition | Observation | Media) | What was found | ||
| 0..1 | string | Which investigations support finding | ||
| 0..* | CodeableConcept | Estimate of likely outcome 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 | ||
| Documentation for this format |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| IN | 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 Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| Σ | 0..1 | uri | Canonical identifier for this code system, represented as a URI (globally unique) (Coding.system) | |
| Σ | 0..* | Identifier | Additional identifier for the code system (business identifier) | |
| Σ | 0..1 | string | Business version of the code system (Coding.version) | |
| ΣI | 0..1 | string | Name for this code system (computer friendly) | |
| Σ | 0..1 | string | Name for this code system (human friendly) | |
| ?!Σ | 1..1 | code | draft | active | retired | unknown PublicationStatus (Required) | |
| Σ | 0..1 | boolean | For testing purposes, not real usage | |
| Σ | 0..1 | dateTime | Date last changed | |
| Σ | 0..1 | string | Name of the publisher (organization or individual) | |
| Σ | 0..* | ContactDetail | Contact details for the publisher | |
| 0..1 | markdown | Natural language description of the code system | ||
| ΣTU | 0..* | UsageContext | The context that the content is intended to support | |
| Σ | 0..* | CodeableConcept | Intended jurisdiction for code system (if applicable) Jurisdiction (Extensible) | |
| 0..1 | markdown | Why this code system is defined | ||
| 0..1 | markdown | Use and/or publishing restrictions | ||
| Σ | 0..1 | boolean | If code comparison is case sensitive | |
| Σ | 0..1 | canonical(ValueSet) | Canonical reference to the value set with entire code system | |
| Σ | 0..1 | code | grouped-by | is-a | part-of | classified-with CodeSystemHierarchyMeaning (Required) | |
| Σ | 0..1 | boolean | If code system defines a compositional grammar | |
| Σ | 0..1 | boolean | If definitions are not stable | |
| Σ | 1..1 | code | not-present | example | fragment | complete | supplement CodeSystemContentMode (Required) | |
| Σ | 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 | exists FilterOperator (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 PropertyType (Required) | |
| 0..* | BackboneElement | Concepts in the code system | ||
| 1..1 | code | Code that identifies concept | ||
| 0..1 | string | Text to display to the user | ||
| 0..1 | string | Formal definition | ||
| 0..* | BackboneElement | Additional representations for the concept | ||
| 0..1 | code | Human language of the designation Common Languages (Preferred but limited to AllLanguages) | ||
| 0..1 | Coding | Details how this designation would be used Designation Use (Extensible) | ||
| 1..1 | string | The text value for this designation | ||
| 0..* | BackboneElement | Property value for the concept | ||
| 1..1 | code | Reference to CodeSystem.property.code | ||
| 1..1 | Value of the property for this concept | |||
| code | ||||
| Coding | ||||
| string | ||||
| integer | ||||
| boolean | ||||
| dateTime | ||||
| decimal | ||||
| 0..* | see concept | Child Concepts (is-a/contains/categorizes) | ||
| Documentation for this format |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | A record of information transmitted from a sender to a receiver 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 this action | |
| 0..* | Reference(Communication) | Reply to | ||
| ?!Σ | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown EventStatus (Required) | |
| Σ | 0..1 | CodeableConcept | Reason for current status CommunicationNotDoneReason (Example) | |
| 0..* | CodeableConcept | Message category CommunicationCategory (Example) | ||
| Σ | 0..1 | code | routine | urgent | asap | stat Request priority (Required) | |
| 0..* | CodeableConcept | A channel of communication v3 Code System ParticipationMode (Example) | ||
| Σ | 0..1 | Reference(Patient | Group) | Focus of message | |
| 0..1 | CodeableConcept | Description of the purpose/content CommunicationTopic (Example) | ||
| 0..* | Reference(Any) | Resources that pertain to this communication | ||
| Σ | 0..1 | Reference(Encounter) | Encounter created as part of | |
| 0..1 | dateTime | When sent | ||
| 0..1 | dateTime | When received | ||
| 0..* | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService) | Message recipient | ||
| 0..1 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService) | Message sender | ||
| Σ | 0..* | CodeableConcept | Indication for message SNOMED CT Clinical Findings (Example) | |
| Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Why was communication done? | |
| 0..* | BackboneElement | Message payload | ||
| 1..1 | Message part content | |||
| string | ||||
| Attachment | ||||
| Reference(Any) | ||||
| 0..* | Annotation | Comments made about the communication | ||
| Documentation for this format |
| 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 RequestStatus (Required) | |
| 0..1 | CodeableConcept | Reason for current status | ||
| 0..* | CodeableConcept | Message category CommunicationCategory (Example) | ||
| Σ | 0..1 | code | routine | urgent | asap | stat Request priority (Required) | |
| ?!Σ | 0..1 | boolean | True if request is prohibiting action | |
| 0..* | CodeableConcept | A channel of communication v3 Code System ParticipationMode (Example) | ||
| 0..1 | Reference(Patient | Group) | Focus of message | ||
| 0..* | Reference(Any) | Resources that pertain to this communication request | ||
| Σ | 0..1 | Reference(Encounter) | Encounter created as part of | |
| 0..* | BackboneElement | Message payload | ||
| 1..1 | Message part content | |||
| string | ||||
| Attachment | ||||
| Reference(Any) | ||||
| Σ | 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/what is requesting service | |
| 0..* | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService) | Message recipient | ||
| Σ | 0..1 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService) | Message sender | |
| Σ | 0..* | CodeableConcept | Why is communication needed? v3 Code System ActReason (Example) | |
| Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Why is communication needed? | |
| 0..* | Annotation | Comments made about communication request | ||
| Documentation for this format |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ITU | 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 | ||
| Σ | 1..1 | uri | Canonical identifier for this compartment definition, represented as a URI (globally unique) | |
| Σ | 0..1 | string | Business version of the compartment definition | |
| ΣI | 1..1 | string | Name for this compartment definition (computer friendly) | |
| ?!Σ | 1..1 | code | draft | active | retired | unknown PublicationStatus (Required) | |
| Σ | 0..1 | boolean | For testing purposes, not real usage | |
| Σ | 0..1 | dateTime | Date last changed | |
| Σ | 0..1 | string | Name of the publisher (organization or individual) | |
| Σ | 0..* | ContactDetail | Contact details for the publisher | |
| 0..1 | markdown | Natural language description of the compartment definition | ||
| Σ | 0..* | UsageContext | The context that the content is intended to support | |
| 0..1 | markdown | Why this compartment definition is defined | ||
| Σ | 1..1 | code | Patient | Encounter | RelatedPerson | Practitioner | Device CompartmentType (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 ResourceType (Required) | |
| Σ | 0..* | string | Search Parameter Name, or chained parameters | |
| 0..1 | string | Additional documentation about the resource and compartment | ||
| Documentation for this format |
| 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 | Identifier | Version-independent identifier for the Composition | |
| ?!Σ | 1..1 | code | preliminary | final | amended | entered-in-error CompositionStatus (Required) | |
| Σ | 1..1 | CodeableConcept | Kind of composition (LOINC if possible) FHIR Document Type Codes (Preferred) | |
| Σ | 0..* | CodeableConcept | Categorization of Composition Document Class Value Set (Example) | |
| Σ | 0..1 | Reference(Any) | Who and/or what the composition is about | |
| Σ | 0..1 | Reference(Encounter) | Context of the Composition | |
| Σ | 1..1 | dateTime | Composition editing time | |
| Σ | 1..* | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) | Who and/or what authored the composition | |
| Σ | 1..1 | string | Human Readable name/title | |
| Σ | 0..1 | code | As defined by affinity domain V3 Value SetConfidentialityClassification (Required) | |
| 0..* | BackboneElement | Attests to accuracy of composition | ||
| 1..1 | code | personal | professional | legal | official CompositionAttestationMode (Required) | ||
| 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..* | BackboneElement | Relationships to other compositions/documents | ||
| 1..1 | code | replaces | transforms | signs | appends DocumentRelationshipType (Required) | ||
| 1..1 | Target of the relationship | |||
| Identifier | ||||
| Reference(Composition) | ||||
| Σ | 0..* | BackboneElement | The clinical service(s) being documented | |
| Σ | 0..* | CodeableConcept | Code(s) that apply to the event being documented v3 Code System ActCode (Example) | |
| Σ | 0..1 | Period | The period covered by the documentation | |
| Σ | 0..* | Reference(Any) | The event(s) being documented | |
| I | 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) 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 | ||
| I | 0..1 | Narrative | Text summary of the section, for human interpretation | |
| 0..1 | code | working | snapshot | changes ListMode (Required) | ||
| 0..1 | CodeableConcept | Order of section entries List Order Codes (Preferred) | ||
| I | 0..* | Reference(Any) | A reference to data that supports this section | |
| I | 0..1 | CodeableConcept | Why the section is empty List Empty Reasons (Preferred) | |
| I | 0..* | see section | Nested Section | |
| Documentation for this format |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ITU | 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 | ||
| Σ | 0..1 | uri | Canonical identifier for this concept map, represented as a URI (globally unique) | |
| Σ | 0..1 | Identifier | Additional identifier for the concept map | |
| Σ | 0..1 | string | Business version of the concept map | |
| ΣI | 0..1 | string | Name for this concept map (computer friendly) | |
| Σ | 0..1 | string | Name for this concept map (human friendly) | |
| ?!Σ | 1..1 | code | draft | active | retired | unknown PublicationStatus (Required) | |
| Σ | 0..1 | boolean | For testing purposes, not real usage | |
| Σ | 0..1 | dateTime | Date last changed | |
| Σ | 0..1 | string | Name of the publisher (organization or individual) | |
| Σ | 0..* | ContactDetail | Contact details for the publisher | |
| 0..1 | markdown | Natural language description of the concept map | ||
| Σ | 0..* | UsageContext | The context that the content is intended to support | |
| Σ | 0..* | CodeableConcept | Intended jurisdiction for concept map (if applicable) Jurisdiction (Extensible) | |
| 0..1 | markdown | Why this concept map is defined | ||
| 0..1 | markdown | Use and/or publishing restrictions | ||
| Σ | 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 | uri | Source system where concepts to be mapped are defined | ||
| 0..1 | string | Specific version of the code system | ||
| 0..1 | uri | Target system that the concepts are to be mapped to | ||
| 0..1 | string | Specific version of the code system | ||
| 1..* | BackboneElement | Mappings for a concept from the source set | ||
| 0..1 | code | Identifies element being mapped | ||
| 0..1 | string | Display for the code | ||
| I | 0..* | BackboneElement | Concept in target system for element + Rule: If the map is narrower or inexact, there SHALL be some comments | |
| 0..1 | code | Code that identifies the target element | ||
| 0..1 | string | Display for the code | ||
| ?! | 1..1 | code | relatedto | equivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint ConceptMapEquivalence (Required) | |
| I | 0..1 | string | Description of status/issues in mapping | |
| 0..* | BackboneElement | Other elements required for this mapping (from context) | ||
| 1..1 | uri | Reference to property mapping depends on | ||
| 0..1 | canonical(CodeSystem) | Code System (if necessary) | ||
| 1..1 | string | Value of the referenced element | ||
| 0..1 | string | Display for the code (if value is a code) | ||
| 0..* | see dependsOn | Other concepts that this mapping also produces | ||
| I | 0..1 | BackboneElement | What to do when there is no mapping for the source concept + Rule: If the mode is 'fixed', a code must be provided + Rule: If the mode is 'other-map', a url must be provided | |
| 1..1 | code | provided | fixed | other-map ConceptMapGroupUnmappedMode (Required) | ||
| 0..1 | code | Fixed code when mode = fixed | ||
| 0..1 | string | Display for the code | ||
| 0..1 | canonical(ConceptMap) | canonical reference to an additional ConceptMap to use for mapping if the source concept is unmapped | ||
| Documentation for this format |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ITU | DomainResource | Detailed information about conditions, problems or diagnoses + Guideline: Condition.clinicalStatus SHALL be present if verificationStatus is not entered-in-error and category is problem-list-item + Rule: If condition is abated, then clinicalStatus must be either inactive, resolved, or remission + Rule: Condition.clinicalStatus SHALL NOT be present if verification Status is entered-in-error Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| Σ | 0..* | Identifier | External Ids for this condition | |
| ?!ΣI | 0..1 | CodeableConcept | active | recurrence | relapse | inactive | remission | resolved Condition Clinical Status Codes (Required) | |
| ?!ΣI | 0..1 | CodeableConcept | unconfirmed | provisional | differential | confirmed | refuted | entered-in-error ConditionVerificationStatus (Required) | |
| 0..* | CodeableConcept | problem-list-item | encounter-diagnosis Condition Category Codes (Extensible) | ||
| 0..1 | CodeableConcept | Subjective severity of condition Condition/Diagnosis Severity (Preferred) | ||
| Σ | 0..1 | CodeableConcept | Identification of the condition, problem or diagnosis Condition/Problem/Diagnosis Codes (Example) | |
| Σ | 0..* | CodeableConcept | Anatomical location, if relevant SNOMED CT Body Structures (Example) | |
| Σ | 1..1 | Reference(Patient | Group) | Who has the condition? | |
| Σ | 0..1 | Reference(Encounter) | Encounter created as part of | |
| Σ | 0..1 | Estimated or actual date, date-time, or age | ||
| dateTime | ||||
| Age | ||||
| Period | ||||
| Range | ||||
| string | ||||
| I | 0..1 | When in resolution/remission | ||
| dateTime | ||||
| Age | ||||
| Period | ||||
| Range | ||||
| string | ||||
| Σ | 0..1 | dateTime | Date record was first recorded | |
| Σ | 0..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) | Who recorded the condition | |
| Σ | 0..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) | Person who asserts this condition | |
| I | 0..* | BackboneElement | Stage/grade, usually assessed formally + Rule: Stage SHALL have summary or assessment | |
| I | 0..1 | CodeableConcept | Simple summary (disease specific) Condition Stage (Example) | |
| I | 0..* | Reference(ClinicalImpression | DiagnosticReport | Observation) | Formal record of assessment | |
| 0..1 | CodeableConcept | Kind of staging Condition Stage Type (Example) | ||
| I | 0..* | BackboneElement | Supporting evidence + Rule: evidence SHALL have code or details | |
| ΣI | 0..* | CodeableConcept | Manifestation/symptom Manifestation and Symptom Codes (Example) | |
| ΣI | 0..* | Reference(Any) | Supporting information found elsewhere | |
| 0..* | Annotation | Additional information about the Condition | ||
| Documentation for this format |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ITU | DomainResource | A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time + Rule: Either a Policy or PolicyRule + Rule: IF Scope=privacy, there must be a patient + Rule: IF Scope=research, there must be a patient + Rule: IF Scope=adr, there must be a patient + Rule: IF Scope=treatment, there must be a patient Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| Σ | 0..* | Identifier | Identifier for this record (external references) | |
| ?!Σ | 1..1 | code | draft | proposed | active | rejected | inactive | entered-in-error ConsentState (Required) | |
| ?!Σ | 1..1 | CodeableConcept | Which of the four areas this resource covers (extensible) Consent Scope Codes (Extensible) | |
| Σ | 1..* | CodeableConcept | Classification of the consent statement - for indexing/retrieval Consent Category Codes (Extensible) | |
| Σ | 0..1 | Reference(Patient) | Who the consent applies to | |
| Σ | 0..1 | dateTime | When this Consent was created or indexed | |
| Σ | 0..* | Reference(Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | Who is agreeing to the policy and rules | |
| Σ | 0..* | Reference(Organization) | Custodian of the consent | |
| Σ | 0..1 | Source from which this consent is taken | ||
| Attachment | ||||
| Reference(Consent | DocumentReference | Contract | QuestionnaireResponse) | ||||
| 0..* | BackboneElement | Policies covered by this consent | ||
| I | 0..1 | uri | Enforcement source for policy | |
| I | 0..1 | uri | Specific policy covered by this consent | |
| ΣI | 0..1 | CodeableConcept | Regulation that this consents to Consent PolicyRule Codes (Extensible) | |
| Σ | 0..* | BackboneElement | Consent Verified by patient or family | |
| Σ | 1..1 | boolean | Has been verified | |
| 0..1 | Reference(Patient | RelatedPerson) | Person who verified | ||
| 0..1 | dateTime | When consent verified | ||
| Σ | 0..1 | BackboneElement | Constraints to the base Consent.policyRule | |
| Σ | 0..1 | code | deny | permit ConsentProvisionType (Required) | |
| Σ | 0..1 | Period | Timeframe for this rule | |
| 0..* | BackboneElement | Who|what controlled by this rule (or group, by role) | ||
| 1..1 | CodeableConcept | How the actor is involved SecurityRoleType (Extensible) | ||
| 1..1 | Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | Resource for the actor (or group, by role) | ||
| Σ | 0..* | CodeableConcept | Actions controlled by this rule Consent Action Codes (Example) | |
| Σ | 0..* | Coding | Security Labels that define affected resources SecurityLabels (Extensible) | |
| Σ | 0..* | Coding | Context of activities covered by this rule V3 Value SetPurposeOfUse (Extensible) | |
| Σ | 0..* | Coding | e.g. Resource Type, Profile, CDA, etc. Consent Content Class (Extensible) | |
| Σ | 0..* | CodeableConcept | e.g. LOINC or SNOMED CT code, etc. in the content Consent Content Codes (Example) | |
| Σ | 0..1 | Period | Timeframe for data controlled by this rule | |
| Σ | 0..* | BackboneElement | Data controlled by this rule | |
| Σ | 1..1 | code | instance | related | dependents | authoredby ConsentDataMeaning (Required) | |
| Σ | 1..1 | Reference(Any) | The actual data reference | |
| 0..* | see provision | Nested Exception Rules | ||
| Documentation for this format |
| 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 | executed | negotiable | offered | policy | rejected | renewed | revoked | resolved | terminated Contract Resource Status Codes (Required) | |
| 0..1 | CodeableConcept | Negotiation status 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 Contract Content Derivation Codes (Example) | ||
| Σ | 0..1 | dateTime | When this Contract was issued | |
| Σ | 0..1 | Period | Effective time | |
| 0..1 | CodeableConcept | Contract cessation cause 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 Contract Resource Scope codes (Example) | ||
| 0..1 | Focus of contract interest | |||
| CodeableConcept | ||||
| Reference(Any) | ||||
| Σ | 0..1 | CodeableConcept | Legal instrument category Contract Type Codes (Example) | |
| Σ | 0..* | CodeableConcept | Subtype within the context of type Contract Subtype Codes (Example) | |
| 0..1 | BackboneElement | Contract precursor content | ||
| 1..1 | CodeableConcept | Content structure and use Contract Resource Definition Type codes (Example) | ||
| 0..1 | CodeableConcept | Detailed Content Type Definition 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 | executed | negotiable | offered | policy | rejected | renewed | revoked | resolved | terminated 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 Contract Term Type Codes (Example) | ||
| 0..1 | CodeableConcept | Contract Term Type specific classification 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 Contract Resource Scope codes (Example) | ||
| 0..* | Coding | Applicable Policy Contract Resource Scope codes (Example) | ||
| 0..* | Coding | Handling Instructions 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 Contract Resource Party Role codes (Example) | ||
| Σ | 0..1 | Reference(Any) | Negotiable offer asset | |
| 0..1 | CodeableConcept | Contract Offer Type or Form Contract Term Type Codes (Example) | ||
| 0..1 | CodeableConcept | Accepting party choice V3 Value SetActConsentDirective (Extensible) | ||
| 0..* | CodeableConcept | How decision is conveyed 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 Contract Resource Asset Scope codes (Example) | ||
| 0..* | CodeableConcept | Asset category Contract Resource Asset Type codes (Example) | ||
| 0..* | Reference(Any) | Associated entities | ||
| 0..* | CodeableConcept | Asset sub-category Contract Resource Asset Sub-Type codes (Example) | ||
| 0..1 | Coding | Kinship of the asset Consent Content Class (Extensible) | ||
| 0..* | BackboneElement | Circumstance of the asset | ||
| 0..1 | Reference(Any) | Creator,custodian or owner | ||
| 0..* | CodeableConcept | Codeable asset context Contract Resource Asset Context codes (Example) | ||
| 0..1 | string | Context description | ||
| 0..1 | string | Quality desctiption of asset | ||
| 0..* | CodeableConcept | Asset availability types 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 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 Contract Actor Role Codes (Example) | ||
| 1..1 | CodeableConcept | Purpose for the Contract Term Action V3 Value SetPurposeOfUse (Example) | ||
| 0..* | string | Pointer to specific item | ||
| 1..1 | CodeableConcept | State of the action 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 Provenance participant type (Example) | ||
| 0..1 | CodeableConcept | Competency of the performer Provenance participant role (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..* | CodeableConcept | Why is action (not) needed? V3 Value SetPurposeOfUse (Example) | ||
| 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference | Questionnaire | QuestionnaireResponse) | Why is action (not) needed? | ||
| 0..* | string | Why action is to be performed | ||
| 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 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) | ||||
| Documentation for this format |
| 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 for the coverage | |
| ?!Σ | 1..1 | code | active | cancelled | draft | entered-in-error Financial Resource Status Codes (Required) | |
| Σ | 0..1 | CodeableConcept | Coverage category such as medical or accident 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..1 | string | ID assigned to the subscriber | |
| Σ | 1..1 | Reference(Patient) | Plan beneficiary | |
| Σ | 0..1 | string | Dependent number | |
| 0..1 | CodeableConcept | Beneficiary relationship to the subscriber SubscriberPolicyholder Relationship Codes (Extensible) | ||
| Σ | 0..1 | Period | Coverage start and end dates | |
| Σ | 1..* | Reference(Organization | Patient | RelatedPerson) | Issuer of the policy | |
| 0..* | BackboneElement | Additional coverage classifications | ||
| Σ | 1..1 | CodeableConcept | Type of class such as 'group' or 'plan' Coverage Class Codes (Extensible) | |
| Σ | 1..1 | string | 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 Coverage Copay Type Codes (Extensible) | |
| Σ | 1..1 | The amount or percentage due from the beneficiary | ||
| SimpleQuantity | ||||
| Money | ||||
| 0..* | BackboneElement | Exceptions for patient payments | ||
| Σ | 1..1 | CodeableConcept | Exception category 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 | ||
| Documentation for this format |
| 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 Financial Resource Status Codes (Required) | |
| 0..1 | CodeableConcept | Desired processing priority Process Priority Codes (Example) | ||
| Σ | 1..* | code | auth-requirements | benefits | discovery | validation EligibilityRequestPurpose (Required) | |
| Σ | 1..1 | Reference(Patient) | Intended recipient of products and services | |
| 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 Benefit Category Codes (Example) | ||
| 0..1 | CodeableConcept | Billing, service, product, or drug code USCLS Codes (Example) | ||
| 0..* | CodeableConcept | Product or service billing modifiers 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 ICD-10 Codes (Example) | |||
| CodeableConcept | ||||
| Reference(Condition) | ||||
| 0..* | Reference(Any) | Product or service details | ||
| Documentation for this format |
| 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 Financial Resource Status Codes (Required) | |
| Σ | 1..* | code | auth-requirements | benefits | discovery | validation EligibilityResponsePurpose (Required) | |
| Σ | 1..1 | Reference(Patient) | Intended recipient of products and services | |
| 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 RemittanceOutcome (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 | ||
| I | 0..* | BackboneElement | Benefits and authorization details + Rule: SHALL contain a category or a billcode but not both. | |
| 0..1 | CodeableConcept | Benefit classification Benefit Category Codes (Example) | ||
| 0..1 | CodeableConcept | Billing, service, product, or drug code USCLS Codes (Example) | ||
| 0..* | CodeableConcept | Product or service billing modifiers 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 Network Type Codes (Example) | ||
| 0..1 | CodeableConcept | Individual or family Unit Type Codes (Example) | ||
| 0..1 | CodeableConcept | Annual or lifetime Benefit Term Codes (Example) | ||
| 0..* | BackboneElement | Benefit Summary | ||
| 1..1 | CodeableConcept | Benefit classification 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 CoverageEligibilityResponse Auth Support Codes (Example) | ||
| 0..1 | uri | Preauthorization requirements endpoint | ||
| 0..1 | string | Preauthorization reference | ||
| 0..1 | CodeableConcept | Printed form identifier Forms (Example) | ||
| 0..* | BackboneElement | Processing errors | ||
| 1..1 | CodeableConcept | Error code detailing processing issues AdjudicationError (Example) | ||
| Documentation for this format |
| 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 | registered | preliminary | final | amended + ObservationStatus (Required) | |
| Σ | 0..1 | CodeableConcept | Issue Category, e.g. drug-drug, duplicate therapy, etc. Detected Issue Category (Preferred) | |
| Σ | 0..1 | code | high | moderate | low DetectedIssueSeverity (Required) | |
| Σ | 0..1 | Reference(Patient) | Associated patient | |
| Σ | 0..1 | When identified | ||
| dateTime | ||||
| Period | ||||
| Σ | 0..1 | Reference(Practitioner | PractitionerRole | Device) | The provider or device that identified the issue | |
| Σ | 0..* | Reference(Any) | Problem resource | |
| 0..* | BackboneElement | Supporting evidence | ||
| 0..* | CodeableConcept | Manifestation Manifestation and Symptom Codes (Example) | ||
| 0..* | Reference(Any) | Supporting information | ||
| 0..1 | string | Description and context | ||
| 0..1 | uri | Authority for issue | ||
| 0..* | BackboneElement | Step taken to address | ||
| 1..1 | CodeableConcept | What mitigation? Detected Issue Mitigation Action (Preferred) | ||
| 0..1 | dateTime | Date committed | ||
| 0..1 | Reference(Practitioner | PractitionerRole) | Who is committing? | ||
| Documentation for this format |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | Item used in healthcare Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| 0..* | Identifier | Instance identifier | ||
| 0..1 | Reference(DeviceDefinition) | The reference to the definition for the device | ||
| Σ | 0..* | BackboneElement | Unique Device Identifier (UDI) Barcode string | |
| Σ | 0..1 | string | Mandatory fixed portion of UDI | |
| 0..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 + UDIEntryType (Required) | ||
| ?!Σ | 0..1 | code | active | inactive | entered-in-error | unknown FHIRDeviceStatus (Required) | |
| 0..* | CodeableConcept | online | paused | standby | offline | not-ready | transduc-discon | hw-discon | off FHIRDeviceStatusReason (Extensible) | ||
| 0..1 | string | The distinct identification string | ||
| 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 | ||
| 0..* | BackboneElement | The name of the device as given by the manufacturer | ||
| 1..1 | string | The name of the device | ||
| 1..1 | code | udi-label-name | user-friendly-name | patient-reported-name | manufacturer-name | model-name | other DeviceNameType (Required) | ||
| 0..1 | string | The model number for the device | ||
| 0..1 | string | The part number of the device | ||
| 0..1 | CodeableConcept | The kind or type of device Device Type (Example) | ||
| 0..* | BackboneElement | The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication | ||
| 1..1 | CodeableConcept | The standard that is used to operate and communicate | ||
| 0..1 | string | The version of the standard that is used to operate and communicate | ||
| 0..* | BackboneElement | The actual design of the device or software version running on the device | ||
| 0..1 | CodeableConcept | The type of the device version | ||
| 0..1 | Identifier | A single component of the device version | ||
| 1..1 | string | The version text | ||
| 0..* | BackboneElement | The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties | ||
| 1..1 | CodeableConcept | Code that specifies the property DeviceDefinitionPropetyCode (Extensible) | ||
| 0..* | Quantity | Property value as a quantity | ||
| 0..* | CodeableConcept | Property value as a code, e.g., NTP4 (synced to NTP) | ||
| 0..1 | Reference(Patient) | Patient to whom Device is affixed | ||
| 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..* | Annotation | Device notes and comments | ||
| Σ | 0..* | CodeableConcept | Safety Characteristics of Device | |
| 0..1 | Reference(Device) | The parent device | ||
| Documentation for this format |
| 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..* | 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 jurisdication porvided 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..1 | Name of device manufacturer | |||
| string | ||||
| Reference(Organization) | ||||
| 0..* | BackboneElement | A name given to the device to identify it | ||
| 1..1 | string | The name of the device | ||
| 1..1 | code | udi-label-name | user-friendly-name | patient-reported-name | manufacturer-name | model-name | other DeviceNameType (Required) | ||
| 0..1 | string | The model number for the device | ||
| 0..1 | CodeableConcept | What kind of device or device system this is FHIR Device Types (Example) | ||
| 0..* | BackboneElement | The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication | ||
| 1..1 | string | The standard that is used to operate and communicate | ||
| 0..1 | string | The version of the standard that is used to operate and communicate | ||
| 0..* | string | Available versions | ||
| Σ | 0..* | CodeableConcept | Safety characteristics of the device Device safety (Example) | |
| 0..* | ProductShelfLife | Shelf Life and storage information | ||
| 0..1 | ProdCharacteristic | Dimensions, color etc. | ||
| 0..* | CodeableConcept | Language code for the human-readable text strings produced by the device (all supported) | ||
| 0..* | BackboneElement | Device capabilities | ||
| 1..1 | CodeableConcept | Type of capability | ||
| 0..* | CodeableConcept | Description of capability | ||
| 0..* | BackboneElement | The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties | ||
| 1..1 | CodeableConcept | Code that specifies the property DeviceDefinitionPropetyCode (Extensible) | ||
| 0..* | Quantity | Property value as a quantity | ||
| 0..* | CodeableConcept | Property value as a code, e.g., NTP4 (synced to NTP) | ||
| 0..1 | Reference(Organization) | Organization responsible for device | ||
| 0..* | ContactPoint | Details for human/organization for support | ||
| 0..1 | uri | Network address to contact device | ||
| 0..1 | uri | Access to on-line information | ||
| 0..* | Annotation | Device notes and comments | ||
| 0..1 | Quantity | The quantity of the device present in the packaging (e.g. the number of devices present in a pack, or the number of devices in the same package of the medicinal product) | ||
| Σ | 0..1 | Reference(DeviceDefinition) | The parent device it can be part of | |
| 0..* | BackboneElement | A substance used to create the material(s) of which the device is made | ||
| 1..1 | CodeableConcept | The substance | ||
| 0..1 | boolean | Indicates an alternative material of the device | ||
| 0..1 | boolean | Whether the substance is a known or suspected allergen | ||
| Documentation for this format |
| 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 Device Metric and Component Types (Preferred) | |
| Σ | 0..1 | CodeableConcept | Unit of Measure for the Metric Device Metric and Component Types (Preferred) | |
| Σ | 0..1 | Reference(Device) | Describes the link to the source Device | |
| Σ | 0..1 | Reference(Device) | Describes the link to the parent Device | |
| Σ | 0..1 | code | on | off | standby | entered-in-error DeviceMetricOperationalStatus (Required) | |
| Σ | 0..1 | code | black | red | green | yellow | blue | magenta | cyan | white DeviceMetricColor (Required) | |
| Σ | 1..1 | code | measurement | setting | calculation | unspecified DeviceMetricCategory (Required) | |
| Σ | 0..1 | Timing | Describes the measurement repetition time | |
| Σ | 0..* | BackboneElement | Describes the calibrations that have been performed or that are required to be performed | |
| Σ | 0..1 | code | unspecified | offset | gain | two-point DeviceMetricCalibrationType (Required) | |
| Σ | 0..1 | code | not-calibrated | calibration-required | calibrated | unspecified DeviceMetricCalibrationState (Required) | |
| Σ | 0..1 | instant | Describes the time last calibration has been performed | |
| Documentation for this format |
| 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(Any) | What request replaces | |
| Σ | 0..1 | Identifier | Identifier of composite request | |
| ?!Σ | 0..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown RequestStatus (Required) | |
| ?!Σ | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option RequestIntent (Required) | |
| Σ | 0..1 | code | routine | urgent | asap | stat Request priority (Required) | |
| Σ | 1..1 | Device requested FHIR Device Types (Example) | ||
| Reference(Device) | ||||
| CodeableConcept | ||||
| 0..* | BackboneElement | Device details | ||
| 0..1 | CodeableConcept | Device detail | ||
| 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 is requesting diagnostics | |
| Σ | 0..1 | CodeableConcept | Filler role Participant Roles (Example) | |
| Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) | Requested Filler | |
| Σ | 0..* | CodeableConcept | Coded Reason for request Condition/Problem/Diagnosis Codes (Example) | |
| Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Linked Reason for request | |
| 0..* | Reference(Coverage | ClaimResponse) | Associated insurance coverage | ||
| 0..* | Reference(Any) | Additional clinical information | ||
| 0..* | Annotation | Notes or comments | ||
| 0..* | Reference(Provenance) | Request provenance | ||
| Documentation for this format |
| 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 | entered-in-error + DeviceUseStatementStatus (Required) | |
| Σ | 1..1 | Reference(Patient | Group) | Patient using device | |
| Σ | 0..* | Reference(ServiceRequest | Procedure | Claim | Observation | QuestionnaireResponse | DocumentReference) | Supporting information | |
| Σ | 0..1 | How often the device was used | ||
| Timing | ||||
| Period | ||||
| dateTime | ||||
| Σ | 0..1 | dateTime | When statement was recorded | |
| Σ | 0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson) | Who made the statement | |
| Σ | 1..1 | Reference(Device) | Reference to device used | |
| Σ | 0..* | CodeableConcept | Why device was used | |
| Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference | Media) | Why was DeviceUseStatement performed? | |
| Σ | 0..1 | CodeableConcept | Target body site SNOMED CT Body Structures (Example) | |
| 0..* | Annotation | Addition details (comments, instructions) | ||
| Documentation for this format |
| 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 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 | final + DiagnosticReportStatus (Required) | |
| Σ | 0..* | CodeableConcept | Service category Diagnostic Service Section Codes (Example) | |
| Σ | 1..1 | CodeableConcept | Name/Code for this diagnostic report LOINC Diagnostic Report Codes (Preferred) | |
| Σ | 0..1 | Reference(Patient | Group | Device | Location) | 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 | ||
| 0..* | Reference(Observation) | Observations | ||
| 0..* | Reference(ImagingStudy) | Reference to full details of imaging associated with the diagnostic report | ||
| Σ | 0..* | BackboneElement | Key images associated with this report | |
| 0..1 | string | Comment about the image (e.g. explanation) | ||
| Σ | 1..1 | Reference(Media) | Reference to the image source | |
| 0..1 | string | Clinical conclusion (interpretation) of test results | ||
| 0..* | CodeableConcept | Codes for the clinical conclusion of test results SNOMED CT Clinical Findings (Example) | ||
| 0..* | Attachment | Entire report as issued | ||
| Documentation for this format |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | A list that defines a set of documents Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| Σ | 0..1 | Identifier | Unique Identifier for the set of documents | |
| Σ | 0..* | Identifier | Other identifiers for the manifest | |
| ?!Σ | 1..1 | code | current | superseded | entered-in-error DocumentReferenceStatus (Required) | |
| Σ | 0..1 | CodeableConcept | Kind of document set v3 Code System ActCode (Example) | |
| Σ | 0..1 | Reference(Patient | Practitioner | Group | Device) | The subject of the set of documents | |
| 0..1 | dateTime | When this document manifest created | ||
| Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) | Who and/or what authored the DocumentManifest | |
| 0..* | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization) | Intended to get notified about this set of documents | ||
| 0..1 | uri | The source system/application/software | ||
| Σ | 0..1 | string | Human-readable description (title) | |
| Σ | 1..* | Reference(Any) | Items in manifest | |
| 0..* | BackboneElement | Related things | ||
| 0..1 | Identifier | Identifiers of things that are related | ||
| 0..1 | Reference(Any) | Related Resource | ||
| Documentation for this format |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | A reference to a document Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| Σ | 0..1 | Identifier | Master Version Specific Identifier | |
| Σ | 0..* | Identifier | Other identifiers for the document | |
| ?!Σ | 1..1 | code | current | superseded | entered-in-error DocumentReferenceStatus (Required) | |
| Σ | 0..1 | code | preliminary | final | amended | entered-in-error CompositionStatus (Required) | |
| Σ | 0..1 | CodeableConcept | Kind of document (LOINC if possible) Document Type Value Set (Preferred) | |
| Σ | 0..* | CodeableConcept | Categorization of document Document Class Value Set (Example) | |
| Σ | 0..1 | Reference(Patient | Practitioner | Group | Device) | Who/what is the subject of the document | |
| Σ | 0..1 | instant | When this document reference was created | |
| Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) | Who and/or what authored the document | |
| 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Who/what authenticated the document | ||
| 0..1 | Reference(Organization) | Organization which maintains the document | ||
| Σ | 0..* | BackboneElement | Relationships to other documents | |
| Σ | 1..1 | code | replaces | transforms | signs | appends DocumentRelationshipType (Required) | |
| Σ | 1..1 | Reference(DocumentReference) | Target of the relationship | |
| Σ | 0..1 | string | Human-readable description | |
| Σ | 0..* | CodeableConcept | Document security-tags SecurityLabels (Extensible) | |
| Σ | 1..* | BackboneElement | Document referenced | |
| Σ | 1..1 | Attachment | Where to access the document | |
| Σ | 0..1 | Coding | Format/content rules for the document DocumentReference Format Code Set (Preferred) | |
| Σ | 0..1 | BackboneElement | Clinical context of document | |
| 0..* | Reference(Encounter | EpisodeOfCare) | Context of the document content | ||
| 0..* | CodeableConcept | Main clinical acts documented v3 Code System ActCode (Example) | ||
| Σ | 0..1 | Period | Time of service that is being documented | |
| 0..1 | CodeableConcept | Kind of facility where patient was seen Facility Type Code Value Set (Example) | ||
| 0..1 | CodeableConcept | Additional details about where the content was created (e.g. clinical specialty) Practice Setting Code Value Set (Example) | ||
| 0..1 | Reference(Patient) | Patient demographics from source | ||
| 0..* | Reference(Any) | Related identifiers or resources | ||
| Documentation for this format |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| IN | 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 | ||
| 0..1 | Narrative | Text summary of the resource, for human interpretation | ||
| 0..* | Resource | Contained, inline Resources | ||
| 0..* | Extension | Additional content defined by implementations | ||
| ?! | 0..* | Extension | Extensions that cannot be ignored | |
| Documentation for this format |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ITU | DomainResource | A quantified estimate of effect based on a body of evidence + 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 | ||
| Σ | 0..1 | uri | Canonical identifier for this effect evidence synthesis, represented as a URI (globally unique) | |
| Σ | 0..* | Identifier | Additional identifier for the effect evidence synthesis | |
| Σ | 0..1 | string | Business version of the effect evidence synthesis | |
| ΣI | 0..1 | string | Name for this effect evidence synthesis (computer friendly) | |
| Σ | 0..1 | string | Name for this effect evidence synthesis (human friendly) | |
| ?!Σ | 1..1 | code | draft | active | retired | unknown PublicationStatus (Required) | |
| Σ | 0..1 | dateTime | Date last changed | |
| Σ | 0..1 | string | Name of the publisher (organization or individual) | |
| Σ | 0..* | ContactDetail | Contact details for the publisher | |
| Σ | 0..1 | markdown | Natural language description of the effect evidence synthesis | |
| 0..* | Annotation | Used for footnotes or explanatory notes | ||
| Σ | 0..* | UsageContext | The context that the content is intended to support | |
| Σ | 0..* | CodeableConcept | Intended jurisdiction for effect evidence synthesis (if applicable) Jurisdiction (Extensible) | |
| 0..1 | markdown | Use and/or publishing restrictions | ||
| 0..1 | date | When the effect evidence synthesis was approved by publisher | ||
| 0..1 | date | When the effect evidence synthesis was last reviewed | ||
| Σ | 0..1 | Period | When the effect evidence synthesis is expected to be used | |
| 0..* | CodeableConcept | The category of the EffectEvidenceSynthesis, such as Education, Treatment, Assessment, etc. DefinitionTopic (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..1 | CodeableConcept | Type of synthesis SynthesisType (Extensible) | ||
| 0..1 | CodeableConcept | Type of study StudyType (Extensible) | ||
| Σ | 1..1 | Reference(EvidenceVariable) | What population? | |
| Σ | 1..1 | Reference(EvidenceVariable) | What exposure? | |
| Σ | 1..1 | Reference(EvidenceVariable) | What comparison exposure? | |
| Σ | 1..1 | Reference(EvidenceVariable) | What outcome? | |
| 0..1 | BackboneElement | What sample size was involved? | ||
| 0..1 | string | Description of sample size | ||
| 0..1 | integer | How many studies? | ||
| 0..1 | integer | How many participants? | ||
| 0..* | BackboneElement | What was the result per exposure? | ||
| 0..1 | string | Description of results by exposure | ||
| 0..1 | code | exposure | exposure-alternative ExposureState (Required) | ||
| 0..1 | CodeableConcept | Variant exposure states EvidenceVariantState (Extensible) | ||
| 1..1 | Reference(RiskEvidenceSynthesis) | Risk evidence synthesis | ||
| Σ | 0..* | BackboneElement | What was the estimated effect | |
| 0..1 | string | Description of effect estimate | ||
| 0..1 | CodeableConcept | Type of efffect estimate EffectEstimateType (Extensible) | ||
| 0..1 | CodeableConcept | Variant exposure states EvidenceVariantState (Extensible) | ||
| 0..1 | decimal | Point estimate | ||
| 0..1 | CodeableConcept | What unit is the outcome described in? UCUM Codes (Required) | ||
| 0..* | BackboneElement | How precise the estimate is | ||
| 0..1 | CodeableConcept | Type of precision estimate PrecisionEstimateType (Extensible) | ||
| 0..1 | decimal | Level of confidence interval | ||
| 0..1 | decimal | Lower bound | ||
| 0..1 | decimal | Upper bound | ||
| 0..* | BackboneElement | How certain is the effect | ||
| 0..* | CodeableConcept | Certainty rating QualityOfEvidenceRating (Extensible) | ||
| 0..* | Annotation | Used for footnotes or explanatory notes | ||
| 0..* | BackboneElement | A component that contributes to the overall certainty | ||
| 0..1 | CodeableConcept | Type of subcomponent of certainty rating CertaintySubcomponentType (Extensible) | ||
| 0..* | CodeableConcept | Subcomponent certainty rating CertaintySubcomponentRating (Extensible) | ||
| 0..* | Annotation | Used for footnotes or explanatory notes | ||
| Documentation for this format |
| 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 | arrived | triaged | in-progress | onleave | finished | cancelled + EncounterStatus (Required) | |
| 0..* | BackboneElement | List of past encounter statuses | ||
| 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + EncounterStatus (Required) | ||
| 1..1 | Period | The time that the episode was in the specified status | ||
| Σ | 1..1 | Coding | Classification of patient encounter V3 Value SetActEncounterCode (Extensible) | |
| 0..* | BackboneElement | List of past encounter classes | ||
| 1..1 | Coding | inpatient | outpatient | ambulatory | emergency + V3 Value SetActEncounterCode (Extensible) | ||
| 1..1 | Period | The time that the episode was in the specified class | ||
| Σ | 0..* | CodeableConcept | Specific type of encounter Encounter type (Example) | |
| Σ | 0..1 | CodeableConcept | Specific type of service Service type (Example) | |
| 0..1 | CodeableConcept | Indicates the urgency of the encounter v3 Code System ActPriority (Example) | ||
| Σ | 0..1 | Reference(Patient | Group) | The patient or group present at the encounter | |
| Σ | 0..* | Reference(EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against | |
| 0..* | Reference(ServiceRequest) | The ServiceRequest that initiated this encounter | ||
| Σ | 0..* | BackboneElement | List of participants involved in the encounter | |
| Σ | 0..* | CodeableConcept | Role of participant in encounter Participant type (Extensible) | |
| 0..1 | Period | Period of time during the encounter that the participant participated | ||
| Σ | 0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson) | Persons involved in the encounter other than the patient | |
| Σ | 0..* | Reference(Appointment) | The appointment that scheduled this encounter | |
| 0..1 | Period | The start and end time of the encounter | ||
| 0..1 | Duration | Quantity of time the encounter lasted (less time absent) | ||
| Σ | 0..* | CodeableConcept | Coded reason the encounter takes place Encounter Reason Codes (Preferred) | |
| Σ | 0..* | Reference(Condition | Procedure | Observation | ImmunizationRecommendation) | Reason the encounter takes place (reference) | |
| Σ | 0..* | BackboneElement | The list of diagnosis relevant to this encounter | |
| Σ | 1..1 | Reference(Condition | Procedure) | The diagnosis or procedure relevant to the encounter | |
| 0..1 | CodeableConcept | Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) DiagnosisRole (Preferred) | ||
| 0..1 | positiveInt | Ranking of the diagnosis (for each role type) | ||
| 0..* | Reference(Account) | The set of accounts that may be used for billing for this Encounter | ||
| 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) Admit source (Preferred) | ||
| 0..1 | CodeableConcept | The type of hospital re-admission that has occurred (if any). If the value is absent, then this is not identified as a readmission v2 RE-ADMISSION INDICATOR (Example) | ||
| 0..* | CodeableConcept | Diet preferences reported by the patient Diet (Example) | ||
| 0..* | CodeableConcept | Special courtesies (VIP, board member) Special courtesy (Preferred) | ||
| 0..* | CodeableConcept | Wheelchair, translator, stretcher, etc. Special arrangements (Preferred) | ||
| 0..1 | Reference(Location | Organization) | Location/organization to which the patient is discharged | ||
| 0..1 | CodeableConcept | Category or kind of location after discharge 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 EncounterLocationStatus (Required) | ||
| 0..1 | CodeableConcept | The physical type of the location (usually the level in the location hierachy - bed room ward etc.) Location type (Example) | ||
| 0..1 | Period | Time period during which the patient was present at the location | ||
| 0..1 | Reference(Organization) | The organization (facility) responsible for this encounter | ||
| 0..1 | Reference(Encounter) | Another Encounter this encounter is part of | ||
| Documentation for this format |
| 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 EndpointStatus (Required) | |
| Σ | 1..1 | Coding | Protocol/Profile/Standard to be used with this endpoint connection Endpoint Connection Type (Extensible) | |
| Σ | 0..1 | string | A name that this endpoint can be identified by | |
| Σ | 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 | |
| Σ | 1..* | CodeableConcept | The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) 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) MimeType (Required) | |
| Σ | 1..1 | url | The technical base address for connecting to this endpoint | |
| 0..* | string | Usage depends on the channel type | ||
| Documentation for this format |
| 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 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 | ||
| Documentation for this format |
| 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 Financial Resource Status Codes (Required) | |
| 0..1 | Reference(EnrollmentRequest) | Claim reference | ||
| 0..1 | code | queued | complete | error | partial RemittanceOutcome (Required) | ||
| 0..1 | string | Disposition Message | ||
| 0..1 | dateTime | Creation date | ||
| 0..1 | Reference(Organization) | Insurer | ||
| 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Responsible practitioner | ||
| Documentation for this format |
| 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 EpisodeOfCareStatus (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 EpisodeOfCareStatus (Required) | ||
| 1..1 | Period | Duration the EpisodeOfCare was in the specified status | ||
| Σ | 0..* | CodeableConcept | Type/class - e.g. specialist referral, disease management Episode of care type (Example) | |
| Σ | 0..* | BackboneElement | The list of diagnosis relevant to this episode of care | |
| Σ | 1..1 | Reference(Condition) | Conditions/problems/diagnoses this episode of care is for | |
| Σ | 0..1 | CodeableConcept | Role that this diagnosis has within the episode of care (e.g. admission, billing, discharge …) DiagnosisRole (Preferred) | |
| Σ | 0..1 | positiveInt | Ranking of the diagnosis (for each role type) | |
| Σ | 1..1 | Reference(Patient) | The patient who is the focus of this episode of care | |
| Σ | 0..1 | Reference(Organization) | Organization that assumes care | |
| Σ | 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 | ||
| Documentation for this format |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ITU | 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 | ||
| Σ | 0..1 | uri | Canonical identifier for this event definition, represented as a URI (globally unique) | |
| Σ | 0..* | Identifier | Additional identifier for the event definition | |
| Σ | 0..1 | string | Business version of the event definition | |
| ΣI | 0..1 | string | Name for this event definition (computer friendly) | |
| Σ | 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 PublicationStatus (Required) | |
| Σ | 0..1 | boolean | For testing purposes, not real usage | |
| 0..1 | Type of individual the event definition is focused on Subject type (Extensible) | |||
| CodeableConcept | ||||
| Reference(Group) | ||||
| Σ | 0..1 | dateTime | Date last changed | |
| Σ | 0..1 | string | Name of the publisher (organization or individual) | |
| Σ | 0..* | ContactDetail | Contact details for the publisher | |
| 0..1 | markdown | Natural language description of the event definition | ||
| Σ | 0..* | UsageContext | The context that the content is intended to support | |
| Σ | 0..* | CodeableConcept | Intended jurisdiction for event definition (if applicable) Jurisdiction (Extensible) | |
| 0..1 | markdown | Why this event definition is defined | ||
| 0..1 | string | Describes the clinical usage of the event definition | ||
| 0..1 | markdown | Use and/or publishing restrictions | ||
| Σ | 0..1 | date | When the event definition was approved by publisher | |
| Σ | 0..1 | date | When the event definition was last reviewed | |
| Σ | 0..1 | Period | When the event definition is expected to be used | |
| 0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc. DefinitionTopic (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') | |
| Documentation for this format |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ITU | DomainResource | A research context or question + 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 | ||
| Σ | 0..1 | uri | Canonical identifier for this evidence, represented as a URI (globally unique) | |
| Σ | 0..* | Identifier | Additional identifier for the evidence | |
| Σ | 0..1 | string | Business version of the evidence | |
| ΣI | 0..1 | string | Name for this evidence (computer friendly) | |
| Σ | 0..1 | string | Name for this evidence (human friendly) | |
| 0..1 | string | Title for use in informal contexts | ||
| 0..1 | string | Subordinate title of the Evidence | ||
| ?!Σ | 1..1 | code | draft | active | retired | unknown PublicationStatus (Required) | |
| Σ | 0..1 | dateTime | Date last changed | |
| Σ | 0..1 | string | Name of the publisher (organization or individual) | |
| Σ | 0..* | ContactDetail | Contact details for the publisher | |
| Σ | 0..1 | markdown | Natural language description of the evidence | |
| 0..* | Annotation | Used for footnotes or explanatory notes | ||
| Σ | 0..* | UsageContext | The context that the content is intended to support | |
| Σ | 0..* | CodeableConcept | Intended jurisdiction for evidence (if applicable) Jurisdiction (Extensible) | |
| 0..1 | markdown | Use and/or publishing restrictions | ||
| 0..1 | date | When the evidence was approved by publisher | ||
| 0..1 | date | When the evidence was last reviewed | ||
| Σ | 0..1 | Period | When the evidence is expected to be used | |
| 0..* | CodeableConcept | The category of the Evidence, such as Education, Treatment, Assessment, etc. DefinitionTopic (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..1 | Reference(EvidenceVariable) | What population? | |
| Σ | 0..* | Reference(EvidenceVariable) | What exposure? | |
| Σ | 0..* | Reference(EvidenceVariable) | What outcome? | |
| Documentation for this format |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ITU | DomainResource | A population, intervention, or exposure definition + 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 | ||
| Σ | 0..1 | uri | Canonical identifier for this evidence variable, represented as a URI (globally unique) | |
| Σ | 0..* | Identifier | Additional identifier for the evidence variable | |
| Σ | 0..1 | string | Business version of the evidence variable | |
| ΣI | 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 | |
| 0..1 | string | Subordinate title of the EvidenceVariable | ||
| ?!Σ | 1..1 | code | draft | active | retired | unknown PublicationStatus (Required) | |
| Σ | 0..1 | dateTime | Date last changed | |
| Σ | 0..1 | string | Name of the publisher (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..* | CodeableConcept | Intended jurisdiction for evidence variable (if applicable) Jurisdiction (Extensible) | |
| 0..1 | markdown | Use and/or publishing restrictions | ||
| 0..1 | date | When the evidence variable was approved by publisher | ||
| 0..1 | date | When the evidence variable was last reviewed | ||
| Σ | 0..1 | Period | When the evidence variable is expected to be used | |
| 0..* | CodeableConcept | The category of the EvidenceVariable, such as Education, Treatment, Assessment, etc. DefinitionTopic (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..1 | code | dichotomous | continuous | descriptive EvidenceVariableType (Required) | |
| Σ | 1..* | BackboneElement | What defines the members of the evidence element | |
| 0..1 | string | Natural language description of the characteristic | ||
| Σ | 1..1 | What code or expression defines members? | ||
| Reference(Group) | ||||
| canonical(ActivityDefinition) | ||||
| CodeableConcept | ||||
| Expression | ||||
| DataRequirement | ||||
| TriggerDefinition | ||||
| 0..* | UsageContext | What code/value pairs define members? | ||
| 0..1 | boolean | Whether the characteristic includes or excludes members | ||
| 0..1 | What time period do participants cover | |||
| dateTime | ||||
| Period | ||||
| Duration | ||||
| Timing | ||||
| 0..1 | Duration | Observation time from study start | ||
| 0..1 | code | mean | median | mean-of-mean | mean-of-median | median-of-mean | median-of-median GroupMeasure (Required) | ||
| Documentation for this format |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ITU | DomainResource | Example of workflow instance + 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 | ||
| Σ | 0..1 | uri | Canonical identifier for this example scenario, represented as a URI (globally unique) | |
| Σ | 0..* | Identifier | Additional identifier for the example scenario | |
| Σ | 0..1 | string | Business version of the example scenario | |
| ΣI | 0..1 | string | Name for this example scenario (computer friendly) | |
| ?!Σ | 1..1 | code | draft | active | retired | unknown PublicationStatus (Required) | |
| Σ | 0..1 | boolean | For testing purposes, not real usage | |
| Σ | 0..1 | dateTime | Date last changed | |
| Σ | 0..1 | string | Name of the publisher (organization or individual) | |
| Σ | 0..* | ContactDetail | Contact details for the publisher | |
| Σ | 0..* | UsageContext | The context that the content is intended to support | |
| Σ | 0..* | CodeableConcept | Intended jurisdiction for example scenario (if applicable) Jurisdiction (Extensible) | |
| 0..1 | markdown | Use and/or publishing restrictions | ||
| 0..1 | markdown | The purpose of the example, e.g. to illustrate a scenario | ||
| 0..* | BackboneElement | Actor participating in the resource | ||
| 1..1 | string | ID or acronym of the actor | ||
| 1..1 | code | person | entity ExampleScenarioActorType (Required) | ||
| 0..1 | string | The name of the actor as shown in the page | ||
| 0..1 | markdown | The description of the actor | ||
| 0..* | BackboneElement | Each resource and each version that is present in the workflow | ||
| 1..1 | string | The id of the resource for referencing | ||
| 1..1 | code | The type of the resource ResourceType (Required) | ||
| 0..1 | string | A short name for the resource instance | ||
| 0..1 | markdown | Human-friendly description of the resource instance | ||
| 0..* | BackboneElement | A specific version of the resource | ||
| 1..1 | string | The identifier of a specific version of a resource | ||
| 1..1 | markdown | The description of the resource version | ||
| 0..* | BackboneElement | Resources contained in the instance | ||
| 1..1 | string | Each resource contained in the instance | ||
| 0..1 | string | A specific version of a resource contained in the instance | ||
| 0..* | BackboneElement | Each major process - a group of operations | ||
| Σ | 1..1 | string | The diagram title of the group of operations | |
| 0..1 | markdown | A longer description of the group of operations | ||
| 0..1 | markdown | Description of initial status before the process starts | ||
| 0..1 | markdown | Description of final status after the process ends | ||
| 0..* | BackboneElement | Each step of the process | ||
| 0..* | see process | Nested process | ||
| 0..1 | boolean | If there is a pause in the flow | ||
| 0..1 | BackboneElement | Each interaction or action | ||
| 1..1 | string | The sequential number of the interaction | ||
| 0..1 | string | The type of operation - CRUD | ||
| 0..1 | string | The human-friendly name of the interaction | ||
| 0..1 | string | Who starts the transaction | ||
| 0..1 | string | Who receives the transaction | ||
| 0..1 | markdown | A comment to be inserted in the diagram | ||
| 0..1 | boolean | Whether the initiator is deactivated right after the transaction | ||
| 0..1 | boolean | Whether the receiver is deactivated right after the transaction | ||
| 0..1 | see containedInstance | Each resource instance used by the initiator | ||
| 0..1 | see containedInstance | Each resource instance used by the responder | ||
| 0..* | BackboneElement | Alternate non-typical step action | ||
| 1..1 | string | Label for alternative | ||
| 0..1 | markdown | A human-readable description of each option | ||
| 0..* | see step | What happens in each alternative option | ||
| 0..* | canonical(ExampleScenario) | Another nested workflow | ||
| Documentation for this format |
| 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 | ||
| ?!Σ | 1..1 | code | active | cancelled | draft | entered-in-error ExplanationOfBenefitStatus (Required) | |
| Σ | 1..1 | CodeableConcept | Category or discipline Claim Type Codes (Extensible) | |
| 0..1 | CodeableConcept | More granular claim type Example Claim SubType Codes (Example) | ||
| Σ | 1..1 | code | claim | preauthorization | predetermination 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) | Author of the claim | ||
| Σ | 1..1 | Reference(Organization) | Party responsible for reimbursement | |
| Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Party responsible for the claim | |
| 0..1 | CodeableConcept | Desired processing urgency ProcessPriority (Example) | ||
| 0..1 | CodeableConcept | For whom to reserve funds FundsReserve (Example) | ||
| 0..1 | CodeableConcept | Funds reserved status FundsReserve (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 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..1 | BackboneElement | Recipient of benefits payable | ||
| 0..1 | CodeableConcept | Category of recipient PayeeType (Example) | ||
| 0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson) | Recipient reference | ||
| 0..1 | Reference(ServiceRequest) | Treatment Referral | ||
| 0..1 | Reference(Location) | Servicing Facility | ||
| 0..1 | Reference(Claim) | Claim reference | ||
| 0..1 | Reference(ClaimResponse) | Claim response reference | ||
| Σ | 1..1 | code | queued | complete | error | partial Claim Processing Codes (Required) | |
| 0..1 | string | Disposition Message | ||
| 0..* | string | Preauthorization reference | ||
| 0..* | Period | Preauthorization in-effect period | ||
| 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 Claim Care Team Role Codes (Example) | ||
| 0..1 | CodeableConcept | Practitioner credential or specialization Example Provider Qualification Codes (Example) | ||
| 0..* | BackboneElement | Supporting information | ||
| 1..1 | positiveInt | Information instance identifier | ||
| 1..1 | CodeableConcept | Classification of the supplied information Claim Information Category Codes (Example) | ||
| 0..1 | CodeableConcept | Type of information Exception Codes (Example) | ||
| 0..1 | When it occurred | |||
| date | ||||
| Period | ||||
| 0..1 | Data to be provided | |||
| boolean | ||||
| string | ||||
| Quantity | ||||
| Attachment | ||||
| Reference(Any) | ||||
| 0..1 | Coding | Explanation for the information Missing Tooth Reason Codes (Example) | ||
| 0..* | BackboneElement | Pertinent diagnosis information | ||
| 1..1 | positiveInt | Diagnosis instance identifier | ||
| 1..1 | Nature of illness or problem ICD-10 Codes (Example) | |||
| CodeableConcept | ||||
| Reference(Condition) | ||||
| 0..* | CodeableConcept | Timing or nature of the diagnosis Example Diagnosis Type Codes (Example) | ||
| 0..1 | CodeableConcept | Present on admission Example Diagnosis on Admission Codes (Example) | ||
| 0..1 | CodeableConcept | Package billing code Example Diagnosis Related Group Codes (Example) | ||
| 0..* | BackboneElement | Clinical procedures performed | ||
| 1..1 | positiveInt | Procedure instance identifier | ||
| 0..* | CodeableConcept | Category of Procedure Example Procedure Type Codes (Example) | ||
| 0..1 | dateTime | When the procedure was performed | ||
| 1..1 | Specific clinical procedure ICD-10 Procedure Codes (Example) | |||
| CodeableConcept | ||||
| Reference(Procedure) | ||||
| 0..* | Reference(Device) | Unique device identifier | ||
| 0..1 | positiveInt | Precedence (primary, secondary, etc.) | ||
| Σ | 1..* | 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 V3 Value SetActIncidentCode (Extensible) | ||
| 0..1 | Where the event occurred | |||
| Address | ||||
| Reference(Location) | ||||
| 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..1 | CodeableConcept | Revenue or cost center code Example Revenue Center Codes (Example) | ||
| 0..1 | CodeableConcept | Benefit classification Benefit Category Codes (Example) | ||
| 1..1 | CodeableConcept | Billing, service, product, or drug code USCLS Codes (Example) | ||
| 0..* | CodeableConcept | Product or service billing modifiers Modifier type Codes (Example) | ||
| 0..* | CodeableConcept | Program the product or service is provided under 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 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 item cost | ||
| 0..* | Reference(Device) | Unique device identifier | ||
| 0..1 | CodeableConcept | Anatomical location Oral Site Codes (Example) | ||
| 0..* | CodeableConcept | Anatomical sub-location Surface Codes (Example) | ||
| 0..* | Reference(Encounter) | Encounters related to this billed item | ||
| 0..* | positiveInt | Applicable note numbers | ||
| 0..* | BackboneElement | Adjudication details | ||
| 1..1 | CodeableConcept | Type of adjudication information Adjudication Value Codes (Example) | ||
| 0..1 | CodeableConcept | Explanation of adjudication outcome Adjudication Reason Codes (Example) | ||
| 0..1 | Money | Monetary amount | ||
| 0..1 | decimal | Non-monitary value | ||
| 0..* | BackboneElement | Additional items | ||
| 1..1 | positiveInt | Product or service provided | ||
| 0..1 | CodeableConcept | Revenue or cost center code Example Revenue Center Codes (Example) | ||
| 0..1 | CodeableConcept | Benefit classification Benefit Category Codes (Example) | ||
| 1..1 | CodeableConcept | Billing, service, product, or drug code USCLS Codes (Example) | ||
| 0..* | CodeableConcept | Service/Product billing modifiers Modifier type Codes (Example) | ||
| 0..* | CodeableConcept | Program the product or service is provided under Example Program Reason 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 item cost | ||
| 0..* | Reference(Device) | Unique device identifier | ||
| 0..* | positiveInt | Applicable note numbers | ||
| 0..* | see adjudication | Detail level adjudication details | ||
| 0..* | BackboneElement | Additional items | ||
| 1..1 | positiveInt | Product or service provided | ||
| 0..1 | CodeableConcept | Revenue or cost center code Example Revenue Center Codes (Example) | ||
| 0..1 | CodeableConcept | Benefit classification Benefit Category Codes (Example) | ||
| 1..1 | CodeableConcept | Billing, service, product, or drug code USCLS Codes (Example) | ||
| 0..* | CodeableConcept | Service/Product billing modifiers Modifier type Codes (Example) | ||
| 0..* | CodeableConcept | Program the product or service is provided under Example Program Reason 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 item cost | ||
| 0..* | Reference(Device) | Unique device identifier | ||
| 0..* | positiveInt | Applicable note numbers | ||
| 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..* | Reference(Practitioner | PractitionerRole | Organization) | Authorized providers | ||
| 1..1 | CodeableConcept | Billing, service, product, or drug code USCLS Codes (Example) | ||
| 0..* | CodeableConcept | Service/Product billing modifiers Modifier type Codes (Example) | ||
| 0..* | CodeableConcept | Program the product or service is provided under 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 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 item cost | ||
| 0..1 | CodeableConcept | Anatomical location Oral Site Codes (Example) | ||
| 0..* | CodeableConcept | Anatomical sub-location Surface Codes (Example) | ||
| 0..* | positiveInt | Applicable note numbers | ||
| 0..* | see adjudication | Added items adjudication | ||
| 0..* | BackboneElement | Insurer added line items | ||
| 1..1 | CodeableConcept | Billing, service, product, or drug code USCLS Codes (Example) | ||
| 0..* | CodeableConcept | Service/Product billing modifiers 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 item cost | ||
| 0..* | positiveInt | Applicable note numbers | ||
| 0..* | see adjudication | Added items adjudication | ||
| 0..* | BackboneElement | Insurer added line items | ||
| 1..1 | CodeableConcept | Billing, service, product, or drug code USCLS Codes (Example) | ||
| 0..* | CodeableConcept | Service/Product billing modifiers 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 item cost | ||
| 0..* | positiveInt | Applicable note numbers | ||
| 0..* | see adjudication | Added items adjudication | ||
| 0..* | see adjudication | Header-level adjudication | ||
| Σ | 0..* | BackboneElement | Adjudication totals | |
| Σ | 1..1 | CodeableConcept | Type of adjudication information Adjudication Value Codes (Example) | |
| Σ | 1..1 | Money | Financial total for the category | |
| 0..1 | BackboneElement | Payment Details | ||
| 0..1 | CodeableConcept | Partial or complete payment Example Payment Type Codes (Example) | ||
| 0..1 | Money | Payment adjustment for non-claim issues | ||
| 0..1 | CodeableConcept | Explanation for the variance 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 Forms (Example) | ||
| 0..1 | Attachment | Printed reference or actual form | ||
| 0..* | BackboneElement | Note concerning adjudication | ||
| 0..1 | positiveInt | Note instance identifier | ||
| 0..1 | code | display | print | printoper NoteType (Required) | ||
| 0..1 | string | Note explanatory text | ||
| 0..1 | CodeableConcept | Language of the text Common Languages (Preferred but limited to AllLanguages) | ||
| 0..1 | Period | When the benefits are applicable | ||
| 0..* | BackboneElement | Balance by Benefit Category | ||
| 1..1 | CodeableConcept | Benefit classification 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 Network Type Codes (Example) | ||
| 0..1 | CodeableConcept | Individual or family Unit Type Codes (Example) | ||
| 0..1 | CodeableConcept | Annual or lifetime Benefit Term Codes (Example) | ||
| 0..* | BackboneElement | Benefit Summary | ||
| 1..1 | CodeableConcept | Benefit classification Benefit Type Codes (Example) | ||
| 0..1 | Benefits allowed | |||
| unsignedInt | ||||
| string | ||||
| Money | ||||
| 0..1 | Benefits used | |||
| unsignedInt | ||||
| Money | ||||
| Documentation for this format |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ITU | 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 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 FamilyHistoryStatus (Required) | |
| Σ | 0..1 | CodeableConcept | subject-unknown | withheld | unable-to-obtain | deferred FamilyHistoryAbsentReason (Example) | |
| Σ | 1..1 | Reference(Patient) | Patient history is about | |
| Σ | 0..1 | dateTime | When history was recorded or last updated | |
| Σ | 0..1 | string | The family member described | |
| Σ | 1..1 | CodeableConcept | Relationship to the subject V3 Value SetFamilyMember (Example) | |
| Σ | 0..1 | CodeableConcept | male | female | other | unknown AdministrativeGender (Extensible) | |
| I | 0..1 | (approximate) date of birth | ||
| Period | ||||
| date | ||||
| string | ||||
| ΣI | 0..1 | (approximate) age | ||
| Age | ||||
| Range | ||||
| string | ||||
| ΣI | 0..1 | boolean | Age is estimated? | |
| Σ | 0..1 | Dead? How old/when? | ||
| boolean | ||||
| Age | ||||
| Range | ||||
| date | ||||
| string | ||||
| Σ | 0..* | CodeableConcept | Why was family member history performed? SNOMED CT Clinical Findings (Example) | |
| Σ | 0..* | Reference(Condition | Observation | AllergyIntolerance | QuestionnaireResponse | DiagnosticReport | DocumentReference) | Why was family member history performed? | |
| 0..* | Annotation | General note about related person | ||
| 0..* | BackboneElement | Condition that the related person had | ||
| 1..1 | CodeableConcept | Condition suffered by relation Condition/Problem/Diagnosis Codes (Example) | ||
| 0..1 | CodeableConcept | deceased | permanent disability | etc. 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 | ||
| Documentation for this format |
| 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 FlagStatus (Required) | |
| Σ | 0..* | CodeableConcept | Clinical, administrative, etc. Flag Category (Example) | |
| Σ | 1..1 | CodeableConcept | Coded or textual message to display to user Flag Code (Example) | |
| Σ | 1..1 | Reference(Patient | Location | Group | Organization | Practitioner | 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 | Practitioner | PractitionerRole) | Flag creator | |
| Documentation for this format |
| 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 GoalLifecycleStatus (Required) | |
| Σ | 0..1 | CodeableConcept | in-progress | improving | worsening | no-change | achieved | sustaining | not-achieved | no-progress | not-attainable Goal achievement status (Preferred) | |
| Σ | 0..* | CodeableConcept | E.g. Treatment, dietary, behavioral, etc. Goal category (Example) | |
| Σ | 0..1 | CodeableConcept | high-priority | medium-priority | low-priority Goal priority (Preferred) | |
| Σ | 1..1 | CodeableConcept | Code or text describing goal SNOMED CT Clinical Findings (Example) | |
| Σ | 1..1 | Reference(Patient | Group | Organization) | Who this goal is intended for | |
| Σ | 0..1 | When goal pursuit begins Goal start event (Example) | ||
| date | ||||
| CodeableConcept | ||||
| I | 0..* | BackboneElement | Target outcome for the goal + Rule: Goal.target.measure is required if Goal.target.detail is populated | |
| ΣI | 0..1 | CodeableConcept | The parameter whose value is being tracked LOINC Codes (Example) | |
| ΣI | 0..1 | The target value to be achieved | ||
| 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) | Who's responsible for creating Goal? | |
| 0..* | Reference(Condition | Observation | MedicationStatement | NutritionOrder | ServiceRequest | RiskAssessment) | Issues addressed by this goal | ||
| 0..* | Annotation | Comments about the goal | ||
| 0..* | CodeableConcept | What result was achieved regarding the goal? SNOMED CT Clinical Findings (Example) | ||
| 0..* | Reference(Observation) | Observation that resulted from goal | ||
| Documentation for this format |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ITU | 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 | ||
| Σ | 0..1 | uri | Canonical identifier for this graph definition, represented as a URI (globally unique) | |
| Σ | 0..1 | string | Business version of the graph definition | |
| ΣI | 1..1 | string | Name for this graph definition (computer friendly) | |
| ?!Σ | 1..1 | code | draft | active | retired | unknown PublicationStatus (Required) | |
| Σ | 0..1 | boolean | For testing purposes, not real usage | |
| Σ | 0..1 | dateTime | Date last changed | |
| Σ | 0..1 | string | Name of the publisher (organization or individual) | |
| Σ | 0..* | ContactDetail | Contact details for the publisher | |
| 0..1 | markdown | Natural language description of the graph definition | ||
| Σ | 0..* | UsageContext | The context that the content is intended to support | |
| Σ | 0..* | CodeableConcept | Intended jurisdiction for graph definition (if applicable) Jurisdiction (Extensible) | |
| 0..1 | markdown | Why this graph definition is defined | ||
| Σ | 1..1 | code | Type of resource at which the graph starts ResourceType (Required) | |
| 0..1 | canonical(StructureDefinition) | Profile on base resource | ||
| 0..* | BackboneElement | Links this graph makes rules about | ||
| 0..1 | string | Path in the resource that contains the link | ||
| 0..1 | string | Which slice (if profiled) | ||
| 0..1 | integer | Minimum occurrences for this link | ||
| 0..1 | string | Maximum occurrences for this link | ||
| 0..1 | string | Why this link is specified | ||
| 0..* | BackboneElement | Potential target for the link | ||
| 1..1 | code | Type of resource this link refers to ResourceType (Required) | ||
| 0..1 | string | Criteria for reverse lookup | ||
| 0..1 | canonical(StructureDefinition) | Profile for the target resource | ||
| 0..* | BackboneElement | Compartment Consistency Rules | ||
| 1..1 | code | condition | requirement GraphCompartmentUse (Required) | ||
| 1..1 | code | Patient | Encounter | RelatedPerson | Practitioner | Device CompartmentType (Required) | ||
| 1..1 | code | identical | matching | different | custom GraphCompartmentRule (Required) | ||
| 0..1 | string | Custom rule, as a FHIRPath expression | ||
| 0..1 | string | Documentation for FHIRPath expression | ||
| 0..* | see link | Additional links from target resource | ||
| Documentation for this format |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ITU | DomainResource | Group of multiple entities + Rule: Can only have members if group is "actual" Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| Σ | 0..* | Identifier | Unique id | |
| Σ | 0..1 | boolean | Whether this group's record is in active use | |
| Σ | 1..1 | code | person | animal | practitioner | device | medication | substance GroupType (Required) | |
| ΣI | 1..1 | boolean | Descriptive or actual | |
| Σ | 0..1 | CodeableConcept | Kind of Group members | |
| Σ | 0..1 | string | Label for 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 | ||
| 1..1 | Value held by characteristic | |||
| CodeableConcept | ||||
| boolean | ||||
| Quantity | ||||
| Range | ||||
| Reference() | ||||
| 1..1 | boolean | Group includes or excludes | ||
| 0..1 | Period | Period over which characteristic is tested | ||
| I | 0..* | BackboneElement | Who or what is in group | |
| 1..1 | Reference(Patient | Practitioner | PractitionerRole | Device | Medication | Substance | Group) | Reference to the group member | ||
| 0..1 | Period | Period member belonged to the group | ||
| 0..1 | boolean | If member is no longer in group | ||
| Documentation for this format |
| 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 | ||
| uri | ||||
| canonical() | ||||
| CodeableConcept | ||||
| ?!Σ | 1..1 | code | success | data-requested | data-required | in-progress | failure | entered-in-error GuidanceResponseStatus (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..* | CodeableConcept | Why guidance is needed | ||
| 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Why guidance is needed | ||
| 0..* | Annotation | Additional notes about the response | ||
| 0..* | 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..1 | Reference(CarePlan | RequestGroup) | Proposed actions, if any | ||
| 0..* | DataRequirement | Additional required data | ||
| Documentation for this format |
| 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..* | CodeableConcept | Broad category of service being performed or delivered Service category (Example) | |
| Σ | 0..* | CodeableConcept | Type of service that may be delivered or performed Service type (Example) | |
| Σ | 0..* | CodeableConcept | Specialties handled by the HealthcareService 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 | string | 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..* | ContactPoint | Contacts related to the healthcare service | ||
| 0..* | Reference(Location) | Location(s) service is intended for/available to | ||
| 0..* | CodeableConcept | Conditions under which service is available/offered ServiceProvisionConditions (Example) | ||
| 0..* | BackboneElement | Specific eligibility requirements required to use the service | ||
| 0..1 | CodeableConcept | Coded value for the eligibility | ||
| 0..1 | markdown | Describes the eligibility conditions for the service | ||
| 0..* | CodeableConcept | Programs that this service is applicable to Program (Example) | ||
| 0..* | CodeableConcept | Collection of characteristics (attributes) | ||
| 0..* | CodeableConcept | The language that this service is offered in Common Languages (Preferred but limited to AllLanguages) | ||
| 0..* | CodeableConcept | Ways that the service accepts referrals ReferralMethod (Example) | ||
| 0..1 | boolean | If an appointment is required for access to this service | ||
| 0..* | BackboneElement | Times the Service Site is available | ||
| 0..* | code | mon | tue | wed | thu | fri | sat | sun DaysOfWeek (Required) | ||
| 0..1 | boolean | Always available? e.g. 24 hour service | ||
| 0..1 | time | Opening time of day (ignored if allDay = true) | ||
| 0..1 | time | Closing time of day (ignored if allDay = true) | ||
| 0..* | BackboneElement | Not available during this time due to provided reason | ||
| 1..1 | string | Reason presented to the user explaining why time not available | ||
| 0..1 | Period | Service not available from this date | ||
| 0..1 | string | Description of availability exceptions | ||
| 0..* | Reference(Endpoint) | Technical endpoints providing access to electronic services operated for the healthcare service | ||
| Documentation for this format |
| 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 ImagingStudyStatus (Required) | |
| Σ | 0..* | Coding | All series modality if actual acquisition modalities AcquisitionModality (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..1 | Reference(Practitioner | PractitionerRole) | Referring physician | |
| Σ | 0..* | Reference(Practitioner | PractitionerRole) | Who interpreted images | |
| Σ | 0..* | Reference(Endpoint) | Study access endpoint | |
| Σ | 0..1 | unsignedInt | Number of Study Related Series | |
| Σ | 0..1 | unsignedInt | Number of Study Related Instances | |
| Σ | 0..1 | Reference(Procedure) | The performed Procedure reference | |
| Σ | 0..* | CodeableConcept | The performed procedure code ImagingProcedureCode (Extensible) | |
| Σ | 0..1 | Reference(Location) | Where ImagingStudy occurred | |
| Σ | 0..* | CodeableConcept | Why the study was requested Procedure Reason Codes (Example) | |
| Σ | 0..* | Reference(Condition | Observation | Media | DiagnosticReport | DocumentReference) | Why was study performed | |
| Σ | 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 | Coding | The modality of the instances in the series AcquisitionModality (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 | Coding | Body part examined SNOMED CT Body Structures (Example) | |
| Σ | 0..1 | Coding | Body part laterality 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 ImagingStudy series performer function (Extensible) | |
| Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) | 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 sopClass (Extensible) | ||
| 0..1 | unsignedInt | The number of this instance in the series | ||
| 0..1 | string | Description of instance | ||
| Documentation for this format |
| 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 | ||
| ?!Σ | 1..1 | code | completed | entered-in-error | not-done Immunization Status Codes (Required) | |
| 0..1 | CodeableConcept | Reason not done Immunization Status Reason Codes (Example) | ||
| Σ | 1..1 | CodeableConcept | Vaccine product administered Vaccine Administered Value Set (Example) | |
| Σ | 1..1 | Reference(Patient) | Who was immunized | |
| 0..1 | Reference(Encounter) | Encounter immunization was part of | ||
| Σ | 1..1 | Vaccine administration date | ||
| dateTime | ||||
| string | ||||
| 0..1 | dateTime | When the immunization was first captured in the subject's record | ||
| Σ | 0..1 | boolean | Indicates context the data was recorded in | |
| 0..1 | CodeableConcept | Indicates the source of a secondarily reported record Immunization Origin Codes (Example) | ||
| 0..1 | Reference(Location) | Where immunization occurred | ||
| 0..1 | Reference(Organization) | Vaccine manufacturer | ||
| 0..1 | string | Vaccine lot number | ||
| 0..1 | date | Vaccine expiration date | ||
| 0..1 | CodeableConcept | Body site vaccine was administered Codes for Immunization Site of Administration (Example) | ||
| 0..1 | CodeableConcept | How vaccine entered body 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 Immunization Function Codes (Extensible) | |
| Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Individual or organization who was performing | |
| Σ | 0..* | Annotation | Additional immunization notes | |
| 0..* | CodeableConcept | Why immunization occurred Immunization Reason Codes (Example) | ||
| 0..* | Reference(Condition | Observation | DiagnosticReport) | Why immunization occurred | ||
| ?!Σ | 0..1 | boolean | Dose potency | |
| 0..* | CodeableConcept | Reason for being subpotent Immunization Subpotent Reason (Example) | ||
| I | 0..* | BackboneElement | Educational material presented to patient + Rule: One of documentType or reference SHALL be present | |
| 0..1 | string | Educational material document identifier | ||
| 0..1 | uri | Educational material reference pointer | ||
| 0..1 | dateTime | Educational material publication date | ||
| 0..1 | dateTime | Educational material presentation date | ||
| 0..* | CodeableConcept | Patient eligibility for a vaccination program Immunization Program Eligibility (Example) | ||
| 0..1 | CodeableConcept | Funding source for the vaccine Immunization Funding Source (Example) | ||
| 0..* | BackboneElement | Details of a reaction that follows immunization | ||
| 0..1 | dateTime | When reaction started | ||
| 0..1 | Reference(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 targetted Immunization Target Disease Codes (Example) | ||
| 1..1 | Dose number within series | |||
| positiveInt | ||||
| string | ||||
| 0..1 | Recommended number of doses for immunity | |||
| positiveInt | ||||
| string | ||||
| Documentation for this format |
| 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 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 | Evaluation target disease Immunization Evaluation Target Disease Codes (Example) | |
| Σ | 1..1 | Reference(Immunization) | Immunization being evaluated | |
| Σ | 1..1 | CodeableConcept | Status of the dose relative to published recommendations Immunization Evaluation Dose Status codes (Example) | |
| 0..* | CodeableConcept | Reason for the dose status Immunization Evaluation Dose Status Reason codes (Example) | ||
| 0..1 | string | Evaluation notes | ||
| 0..1 | string | Name of vaccine series | ||
| 0..1 | Dose number within series | |||
| positiveInt | ||||
| string | ||||
| 0..1 | Recommended number of doses for immunity | |||
| positiveInt | ||||
| string | ||||
| Documentation for this format |
| 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 | ||
| ΣI | 1..* | BackboneElement | Vaccine administration recommendations + Rule: One of vaccineCode or targetDisease SHALL be present | |
| Σ | 0..* | CodeableConcept | Vaccine or vaccine group recommendation applies to Vaccine Administered Value Set (Example) | |
| Σ | 0..1 | CodeableConcept | Disease to be immunized against Immunization Recommendation Target Disease Codes (Example) | |
| Σ | 0..* | CodeableConcept | Vaccine which is contraindicated to fulfill the recommendation Vaccine Administered Value Set (Example) | |
| ?!Σ | 1..1 | CodeableConcept | Vaccine recommendation status Immunization Recommendation Status Codes (Example) | |
| Σ | 0..* | CodeableConcept | Vaccine administration status reason Immunization Recommendation Reason Codes (Example) | |
| 0..* | BackboneElement | Dates governing proposed immunization | ||
| 1..1 | CodeableConcept | Type of date Immunization Recommendation Date Criterion Codes (Example) | ||
| 1..1 | dateTime | Recommended date | ||
| 0..1 | string | Protocol details | ||
| 0..1 | string | Name of vaccination series | ||
| Σ | 0..1 | Recommended dose number within series | ||
| positiveInt | ||||
| string | ||||
| 0..1 | Recommended number of doses for immunity | |||
| positiveInt | ||||
| string | ||||
| 0..* | Reference(Immunization | ImmunizationEvaluation) | Past immunizations supporting recommendation | ||
| 0..* | Reference(Any) | Patient observations supporting recommendation | ||
| Documentation for this format |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ITU | 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 oe of the versions defined for the Implementation Guide Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| Σ | 1..1 | uri | Canonical identifier for this implementation guide, represented as a URI (globally unique) | |
| Σ | 0..1 | string | Business version of the implementation guide | |
| ΣI | 1..1 | string | Name for this implementation guide (computer friendly) | |
| Σ | 0..1 | string | Name for this implementation guide (human friendly) | |
| ?!Σ | 1..1 | code | draft | active | retired | unknown PublicationStatus (Required) | |
| Σ | 0..1 | boolean | For testing purposes, not real usage | |
| Σ | 0..1 | dateTime | Date last changed | |
| Σ | 0..1 | string | Name of the publisher (organization or individual) | |
| Σ | 0..* | ContactDetail | Contact details for the publisher | |
| 0..1 | markdown | Natural language description of the implementation guide | ||
| Σ | 0..* | UsageContext | The context that the content is intended to support | |
| Σ | 0..* | CodeableConcept | Intended jurisdiction for implementation guide (if applicable) Jurisdiction (Extensible) | |
| 0..1 | markdown | Use and/or publishing restrictions | ||
| Σ | 1..1 | id | NPM Package name for IG | |
| Σ | 0..1 | code | SPDX license code for this IG (or not-open-source) SPDXLicense (Required) | |
| Σ | 1..* | code | FHIR Version(s) this Implementation Guide targets 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..* | BackboneElement | Profiles that apply globally | |
| Σ | 1..1 | code | Type this profile applies to ResourceType (Required) | |
| Σ | 1..1 | canonical(StructureDefinition) | Profile that all resources must conform to | |
| I | 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 | |
| 0..* | BackboneElement | Grouping used to present related resources in the IG | ||
| 1..1 | string | Descriptive name for the package | ||
| 0..1 | string | Human readable text describing the package | ||
| 1..* | BackboneElement | Resource in the implementation guide | ||
| 1..1 | Reference(Any) | Location of the resource | ||
| 0..* | code | Versions this applies to (if different to IG) FHIRVersion (Required) | ||
| 0..1 | string | Human Name for the resource | ||
| 0..1 | string | Reason why included in guide | ||
| 0..1 | Is an example/What is this an example of? | |||
| boolean | ||||
| canonical(StructureDefinition) | ||||
| 0..1 | id | Grouping this is part of | ||
| 0..1 | BackboneElement | Page/Section in the Guide | ||
| 1..1 | Where to find that page | |||
| url | ||||
| Reference(Binary) | ||||
| 1..1 | string | Short title shown for navigational assistance | ||
| 1..1 | code | html | markdown | xml | generated GuidePageGeneration (Required) | ||
| 0..* | see page | Nested Pages / Sections | ||
| 0..* | BackboneElement | Defines how IG is built by tools | ||
| 1..1 | code | apply | path-resource | path-pages | path-tx-cache | expansion-parameter | rule-broken-links | generate-xml | generate-json | generate-turtle | html-template GuideParameterCode (Required) | ||
| 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 | Is an example/What is this an example of? | |||
| boolean | ||||
| canonical(StructureDefinition) | ||||
| 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 | ||
| Documentation for this format |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ITU | DomainResource | Details of a Health Insurance product/plan provided by an organization + Rule: The organization SHALL at least have a name or an idendtifier, and possibly more than one Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| ΣI | 0..* | Identifier | Business Identifier for Product | |
| ?!Σ | 0..1 | code | draft | active | retired | unknown PublicationStatus (Required) | |
| Σ | 0..* | CodeableConcept | Kind of product Insurance plan type (Example) | |
| ΣI | 0..1 | string | Official name | |
| 0..* | string | Alternate names | ||
| 0..1 | Period | When the product is available | ||
| Σ | 0..1 | Reference(Organization) | Plan issuer | |
| Σ | 0..1 | Reference(Organization) | Product administrator | |
| Σ | 0..* | Reference(Location) | Where product applies | |
| 0..* | BackboneElement | Contact for the product | ||
| 0..1 | CodeableConcept | The type of contact Contact entity type (Extensible) | ||
| 0..1 | HumanName | A name associated with the contact | ||
| 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact | ||
| 0..1 | Address | Visiting or postal addresses for the contact | ||
| 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 Benefit cost applicability (Required) | ||
| 0..* | CodeableConcept | Additional information about the cost | ||
| 0..1 | Quantity | The actual cost value | ||
| Documentation for this format |
| 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 InvoiceStatus (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 | Invoice date / posting date | |
| 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 | ||
| 1..1 | Reference to ChargeItem containing details of this line item or an inline billing code | |||
| Reference(ChargeItem) | ||||
| CodeableConcept | ||||
| 0..* | BackboneElement | Components of total line item price | ||
| 1..1 | code | base | surcharge | deduction | discount | tax | informational InvoicePriceComponentType (Required) | ||
| 0..1 | CodeableConcept | Code identifying the specific component | ||
| 0..1 | decimal | Factor used for calculating this component | ||
| 0..1 | Money | Monetary amount associated with this component | ||
| 0..* | see priceComponent | 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 | ||
| Documentation for this format |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ITU | 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 | ||
| Σ | 0..1 | uri | Canonical identifier for this library, represented as a URI (globally unique) | |
| Σ | 0..* | Identifier | Additional identifier for the library | |
| Σ | 0..1 | string | Business version of the library | |
| ΣI | 0..1 | string | Name for this library (computer friendly) | |
| Σ | 0..1 | string | Name for this library (human friendly) | |
| 0..1 | string | Subordinate title of the library | ||
| ?!Σ | 1..1 | code | draft | active | retired | unknown PublicationStatus (Required) | |
| Σ | 0..1 | boolean | For testing purposes, not real usage | |
| Σ | 1..1 | CodeableConcept | logic-library | model-definition | asset-collection | module-definition LibraryType (Extensible) | |
| 0..1 | Type of individual the library content is focused on Subject type (Extensible) | |||
| CodeableConcept | ||||
| Reference(Group) | ||||
| Σ | 0..1 | dateTime | Date last changed | |
| Σ | 0..1 | string | Name of the publisher (organization or individual) | |
| Σ | 0..* | ContactDetail | Contact details for the publisher | |
| Σ | 0..1 | markdown | Natural language description of the library | |
| Σ | 0..* | UsageContext | The context that the content is intended to support | |
| Σ | 0..* | CodeableConcept | Intended jurisdiction for library (if applicable) Jurisdiction (Extensible) | |
| 0..1 | markdown | Why this library is defined | ||
| 0..1 | string | Describes the clinical usage of the library | ||
| 0..1 | markdown | Use and/or publishing restrictions | ||
| 0..1 | date | When the library was approved by publisher | ||
| 0..1 | date | When the library was last reviewed | ||
| Σ | 0..1 | Period | When the library is expected to be used | |
| 0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc. DefinitionTopic (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 | |
| Documentation for this format |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ΣITU | 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 | |
| ΣI | 1..* | BackboneElement | Item to be linked | |
| Σ | 1..1 | code | source | alternate | historical LinkageType (Required) | |
| Σ | 1..1 | Reference(Any) | Resource being linked | |
| Documentation for this format |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ITU | DomainResource | A list is a curated collection of resources + Rule: A list can only have an emptyReason if it is empty + Rule: The deleted flag can only be used if the mode of the list is "changes" + Rule: An entry date can only be used if the mode of the list is "working" Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| 0..* | Identifier | Business identifier | ||
| ?!Σ | 1..1 | code | current | retired | entered-in-error ListStatus (Required) | |
| ?!Σ | 1..1 | code | working | snapshot | changes ListMode (Required) | |
| Σ | 0..1 | string | Descriptive name for the list | |
| Σ | 0..1 | CodeableConcept | What the purpose of this list is Example Use Codes for List (Example) | |
| Σ | 0..1 | Reference(Patient | Group | Device | Location) | If all resources have the same subject | |
| 0..1 | Reference(Encounter) | Context in which list created | ||
| Σ | 0..1 | dateTime | When the list was prepared | |
| Σ | 0..1 | Reference(Practitioner | PractitionerRole | Patient | Device) | Who and/or what defined the list contents (aka Author) | |
| 0..1 | CodeableConcept | What order the list has List Order Codes (Preferred) | ||
| 0..* | Annotation | Comments about the list | ||
| I | 0..* | BackboneElement | Entries in the list | |
| 0..1 | CodeableConcept | Status/Workflow information about this item Patient Medicine Change Types (Example) | ||
| ?!I | 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 | ||
| I | 0..1 | CodeableConcept | Why list is empty List Empty Reasons (Preferred) | |
| Documentation for this format |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | Details and position information for a physical 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 LocationStatus (Required) | |
| Σ | 0..1 | Coding | The operational status of the location (typically only for a bed/room) v2 BED STATUS (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 | string | Additional details about the location that could be displayed as further information to identify the location beyond its name | |
| Σ | 0..1 | code | instance | kind LocationMode (Required) | |
| Σ | 0..* | CodeableConcept | Type of function performed V3 Value SetServiceDeliveryLocationRoleType (Extensible) | |
| 0..* | ContactPoint | Contact details of the location | ||
| 0..1 | Address | Physical location | ||
| Σ | 0..1 | CodeableConcept | Physical form of the location Location type (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..* | BackboneElement | What days/times during a week is this location usually open | ||
| 0..* | code | mon | tue | wed | thu | fri | sat | sun DaysOfWeek (Required) | ||
| 0..1 | boolean | The Location is open all day | ||
| 0..1 | time | Time that the Location opens | ||
| 0..1 | time | Time that the Location closes | ||
| 0..1 | string | Description of availability exceptions | ||
| 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the location | ||
| Documentation for this format |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ITU | 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 | ||
| Σ | 0..1 | uri | Canonical identifier for this measure, represented as a URI (globally unique) | |
| Σ | 0..* | Identifier | Additional identifier for the measure | |
| Σ | 0..1 | string | Business version of the measure | |
| ΣI | 0..1 | string | Name for this measure (computer friendly) | |
| Σ | 0..1 | string | Name for this measure (human friendly) | |
| 0..1 | string | Subordinate title of the measure | ||
| ?!Σ | 1..1 | code | draft | active | retired | unknown PublicationStatus (Required) | |
| Σ | 0..1 | boolean | For testing purposes, not real usage | |
| 0..1 | E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device Subject type (Extensible) | |||
| CodeableConcept | ||||
| Reference(Group) | ||||
| Σ | 0..1 | dateTime | Date last changed | |
| Σ | 0..1 | string | Name of the publisher (organization or individual) | |
| Σ | 0..* | ContactDetail | Contact details for the publisher | |
| Σ | 0..1 | markdown | Natural language description of the measure | |
| Σ | 0..* | UsageContext | The context that the content is intended to support | |
| Σ | 0..* | CodeableConcept | Intended jurisdiction for measure (if applicable) Jurisdiction (Extensible) | |
| 0..1 | markdown | Why this measure is defined | ||
| 0..1 | string | Describes the clinical usage of the measure | ||
| 0..1 | markdown | Use and/or publishing restrictions | ||
| 0..1 | date | When the measure was approved by publisher | ||
| 0..1 | date | When the measure was last reviewed | ||
| Σ | 0..1 | Period | When the measure is expected to be used | |
| 0..* | CodeableConcept | The category of the measure, such as Education, Treatment, Assessment, etc. DefinitionTopic (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 MeasureScoring (Extensible) | |
| Σ | 0..1 | CodeableConcept | opportunity | all-or-nothing | linear | weighted CompositeMeasureScoring (Extensible) | |
| Σ | 0..* | CodeableConcept | process | outcome | structure | patient-reported-outcome | composite MeasureType (Extensible) | |
| Σ | 0..1 | string | How risk adjustment is applied for this measure | |
| Σ | 0..1 | string | 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 MeasureImprovementNotation (Required) | |
| Σ | 0..* | markdown | Defined terms used in the measure documentation | |
| Σ | 0..1 | markdown | Additional guidance for implementers | |
| 0..* | BackboneElement | Population criteria group | ||
| 0..1 | CodeableConcept | Meaning of the group | ||
| 0..1 | string | Summary description | ||
| 0..* | BackboneElement | Population criteria | ||
| 0..1 | CodeableConcept | initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-observation MeasurePopulationType (Extensible) | ||
| 0..1 | string | The human readable description of this population criteria | ||
| 1..1 | Expression | The criteria that defines this population | ||
| 0..* | BackboneElement | Stratifier criteria for the measure | ||
| 0..1 | CodeableConcept | Meaning of the stratifier | ||
| 0..1 | string | The human readable description of this stratifier | ||
| 0..1 | Expression | How the measure should be stratified | ||
| 0..* | BackboneElement | Stratifier criteria component for the measure | ||
| 0..1 | CodeableConcept | Meaning of the stratifier component | ||
| 0..1 | string | The human readable description of this stratifier component | ||
| 1..1 | Expression | Component of how the measure should be stratified | ||
| 0..* | BackboneElement | What other data should be reported with the measure | ||
| 0..1 | CodeableConcept | Meaning of the supplemental data | ||
| 0..* | CodeableConcept | supplemental-data | risk-adjustment-factor MeasureDataUsage (Extensible) | ||
| 0..1 | string | The human readable description of this supplemental data | ||
| 1..1 | Expression | Expression describing additional data to be reported | ||
| Documentation for this format |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ITU | 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 MeasureReportStatus (Required) | |
| ΣI | 1..1 | code | individual | subject-list | summary | data-collection MeasureReportType (Required) | |
| Σ | 1..1 | canonical(Measure) | What measure was calculated | |
| Σ | 0..1 | Reference(Patient | Practitioner | PractitionerRole | Location | Device | RelatedPerson | Group) | What individual(s) the report is for | |
| Σ | 0..1 | dateTime | When the report was generated | |
| Σ | 0..1 | Reference(Practitioner | PractitionerRole | Location | Organization) | Who is reporting the data | |
| Σ | 1..1 | Period | What period the report covers | |
| ?!Σ | 0..1 | CodeableConcept | increase | decrease MeasureImprovementNotation (Required) | |
| I | 0..* | BackboneElement | Measure results for each group | |
| Σ | 0..1 | CodeableConcept | Meaning of the group | |
| 0..* | BackboneElement | The populations in the group | ||
| Σ | 0..1 | CodeableConcept | initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-observation MeasurePopulationType (Extensible) | |
| 0..1 | integer | Size of the population | ||
| 0..1 | Reference(List) | For subject-list reports, the subject results in this population | ||
| Σ | 0..1 | Quantity | What score this group achieved | |
| 0..* | BackboneElement | Stratification results | ||
| 0..* | CodeableConcept | What stratifier of the group | ||
| 0..* | BackboneElement | Stratum results, one for each unique value, or set of values, in the stratifier, or stratifier components | ||
| 0..1 | CodeableConcept | The stratum value, e.g. male | ||
| 0..* | BackboneElement | Stratifier component values | ||
| 1..1 | CodeableConcept | What stratifier component of the group | ||
| 1..1 | CodeableConcept | The stratum component value, e.g. male | ||
| 0..* | BackboneElement | Population results in this stratum | ||
| 0..1 | CodeableConcept | initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-observation MeasurePopulationType (Extensible) | ||
| 0..1 | integer | Size of the population | ||
| 0..1 | Reference(List) | For subject-list reports, the subject results in this population | ||
| 0..1 | Quantity | What score this stratum achieved | ||
| 0..* | Reference(Any) | What data was used to calculate the measure score | ||
| Documentation for this format |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TU | DomainResource | A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| Σ | 0..* | Identifier | Identifier(s) for the image | |
| Σ | 0..* | Reference(ServiceRequest | CarePlan) | Procedure that caused this media to be created | |
| Σ | 0..* | Reference(Any) | Part of referenced event | |
| ?!Σ | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown EventStatus (Required) | |
| Σ | 0..1 | CodeableConcept | Classification of media as image, video, or audio Media Type (Extensible) | |
| Σ | 0..1 | CodeableConcept | The type of acquisition equipment/process Media Modality (Example) | |
| Σ | 0..1 | CodeableConcept | Imaging view, e.g. Lateral or Antero-posterior Media Collection View/Projection (Example) | |
| Σ | 0..1 | Reference(Patient | Practitioner | PractitionerRole | Group | Device | Specimen | Location) | Who/What this Media is a record of | |
| Σ | 0..1 | Reference(Encounter) | Encounter associated with media | |
| Σ | 0..1 | When Media was collected | ||
| dateTime | ||||
| Period | ||||
| Σ | 0..1 | instant | Date/Time this version was made available | |
| Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) | The person who generated the image | |
| Σ | 0..* | CodeableConcept | Why was event performed? Procedure Reason Codes (Example) | |
| Σ | 0..1 | CodeableConcept | Observed body part SNOMED CT Body Structures (Example) | |
| Σ | 0..1 | string | Name of the device/manufacturer | |
| Σ | 0..1 | Reference(Device | DeviceMetric | Device) | Observing Device | |
| Σ | 0..1 | positiveInt | Height of the image in pixels (photo/video) | |
| Σ | 0..1 | positiveInt | Width of the image in pixels (photo/video) | |
| Σ | 0..1 | positiveInt | Number of frames if > 1 (photo) | |
| Σ | 0..1 | decimal | Length in seconds (audio / video) | |
| Σ | 1..1 | Attachment | Actual Media - reference or data | |
| 0..* | Annotation | Comments made about the media | ||
| Documentation for this format |
\"].value"
},
{
"identity" : "dicom",
"map" : "0028,0010"
}]
},
{
"id" : "Media.width",
"path" : "Media.width",
"short" : "Width of the image in pixels (photo/video)",
"definition" : "Width of the image in pixels (photo/video).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Media.width",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "positiveInt"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=\"COMP].target[classCode=\"OBS\", moodCode=\"EVN\",code=\"\"].value"
},
{
"identity" : "dicom",
"map" : "0028,0011"
}]
},
{
"id" : "Media.frames",
"path" : "Media.frames",
"short" : "Number of frames if > 1 (photo)",
"definition" : "The number of frames in a photo. This is used with a multi-page fax, or an imaging acquisition context that takes multiple slices in a single image, or an animated gif. If there is more than one frame, this SHALL have a value in order to alert interface software that a multi-frame capable rendering widget is required.",
"comment" : "if the number of frames is not supplied, the value may be unknown. Applications should not assume that there is only one frame unless it is explicitly stated.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Media.frames",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "positiveInt"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=\"COMP].target[classCode=\"OBS\", moodCode=\"EVN\",code=\"\"].value"
}]
},
{
"id" : "Media.duration",
"path" : "Media.duration",
"short" : "Length in seconds (audio / video)",
"definition" : "The duration of the recording in seconds - for audio and video.",
"comment" : "The duration might differ from occurrencePeriod if recording was paused.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Media.duration",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "decimal"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=\"COMP].target[classCode=\"OBS\", moodCode=\"EVN\",code=\"\"].value"
},
{
"identity" : "dicom",
"map" : "~0028,0002"
}]
},
{
"id" : "Media.content",
"path" : "Media.content",
"short" : "Actual Media - reference or data",
"definition" : "The actual content of the media - inline or by direct reference to the media source file.",
"comment" : "Recommended content types: image/jpeg, image/png, image/tiff, video/mpeg, audio/mp4, application/dicom. Application/dicom can contain the transfer syntax as a parameter. For media that covers a period of time (video/sound), the content.creationTime is the end time. Creation time is used for tracking, organizing versions and searching.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Media.content",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "Attachment"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : ".text"
}]
},
{
"id" : "Media.note",
"path" : "Media.note",
"short" : "Comments made about the media",
"definition" : "Comments made about the media by the performer, subject or other participants.",
"comment" : "Not to be used for observations, conclusions, etc. Instead use an [Observation](observation.html) based on the Media/ImagingStudy resource.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Media.note",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Annotation"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.note"
},
{
"identity" : "v2",
"map" : "NTE"
},
{
"identity" : "rim",
"map" : ".inboundRelationship(typeCode=SUBJ].source[classCode=ANNGEN, moodCode=EVN].value[xsi:type=ST]"
}]
}]
},
"differential" : {
"element" : [{
"id" : "Media",
"path" : "Media",
"short" : "A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference",
"definition" : "A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference.",
"min" : 0,
"max" : "*",
"mapping" : [{
"identity" : "workflow",
"map" : "Event"
},
{
"identity" : "rim",
"map" : "Act[classCode=\"DGIMG\", moodCode=\"EVN\"]"
}]
},
{
"id" : "Media.identifier",
"path" : "Media.identifier",
"short" : "Identifier(s) for the image",
"definition" : "Identifiers associated with the image - these may include identifiers for the image itself, identifiers for the context of its collection (e.g. series ids) and context ids such as accession numbers or other workflow identifiers.",
"comment" : "The identifier label and use can be used to determine what kind of identifier it is.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Identifier"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.identifier"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "rim",
"map" : ".id"
},
{
"identity" : "dicom",
"map" : "0008,0018 | ~0008,0050 | 0020,000D | 0020,000E"
}]
},
{
"id" : "Media.basedOn",
"path" : "Media.basedOn",
"short" : "Procedure that caused this media to be created",
"definition" : "A procedure that is fulfilled in whole or in part by the creation of this media.",
"requirements" : "Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon.",
"alias" : ["fulfills"],
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ServiceRequest",
"http://hl7.org/fhir/StructureDefinition/CarePlan"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.basedOn"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=FLFS].target"
}]
},
{
"id" : "Media.partOf",
"path" : "Media.partOf",
"short" : "Part of referenced event",
"definition" : "A larger event of which this particular event is a component or step.",
"comment" : "Not to be used to link an event to an Encounter - use Media.encounter for that.\r\r[The allowed reference resources may be adjusted as appropriate for the event resource].",
"requirements" : "E.g. Drug administration as part of a procedure, procedure as part of observation, etc.",
"alias" : ["container"],
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.partOf"
},
{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=COMP].source[moodCode=EVN]"
}]
},
{
"id" : "Media.status",
"path" : "Media.status",
"short" : "preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown",
"definition" : "The current state of the {{title}}.",
"comment" : "A nominal state-transition diagram can be found in the [[event.html#statemachine | Event pattern]] documentation\r\rUnknown does not represent \"other\" - one of the defined statuses must apply. Unknown is used when the authoring system is not sure what the current status is.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isModifier" : true,
"isModifierReason" : "This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MediaStatus"
}],
"strength" : "required",
"description" : "Codes identifying the lifecycle stage of an event.",
"valueSet" : "http://hl7.org/fhir/ValueSet/event-status|4.0.1"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.status"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
},
{
"identity" : "v2",
"map" : "Varies by domain"
},
{
"identity" : "rim",
"map" : ".status"
}]
},
{
"id" : "Media.type",
"path" : "Media.type",
"short" : "Classification of media as image, video, or audio",
"definition" : "A code that classifies whether the media is an image, video or audio recording or some other media category.",
"requirements" : "Used for filtering what observations are retrieved and displayed.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MediaType"
}],
"strength" : "extensible",
"description" : "Codes for high level media categories.",
"valueSet" : "http://hl7.org/fhir/ValueSet/media-type"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.class"
},
{
"identity" : "rim",
"map" : ".code"
}]
},
{
"id" : "Media.modality",
"path" : "Media.modality",
"short" : "The type of acquisition equipment/process",
"definition" : "Details of the type of the media - usually, how it was acquired (what type of device). If images sourced from a DICOM system, are wrapped in a Media resource, then this is the modality.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MediaModality"
}],
"strength" : "example",
"description" : "Detailed information about the type of the image - its kind, purpose, or the kind of equipment used to generate it.",
"valueSet" : "http://hl7.org/fhir/ValueSet/media-modality"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.code"
},
{
"identity" : "w5",
"map" : "FiveWs.what[x]"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=\"COMP].target[classCode=\"LIST\", moodCode=\"EVN\"].code"
},
{
"identity" : "dicom",
"map" : "0008,0060 | 0008,1032"
}]
},
{
"id" : "Media.view",
"path" : "Media.view",
"short" : "Imaging view, e.g. Lateral or Antero-posterior",
"definition" : "The name of the imaging view e.g. Lateral or Antero-posterior (AP).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MediaView"
}],
"strength" : "example",
"description" : "Imaging view (projection) used when collecting an image.",
"valueSet" : "http://hl7.org/fhir/ValueSet/media-view"
},
"mapping" : [{
"identity" : "rim",
"map" : "DiagnosticImage.subjectOrientationCode"
}]
},
{
"id" : "Media.subject",
"path" : "Media.subject",
"short" : "Who/What this Media is a record of",
"definition" : "Who/What this Media is a record of.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Group",
"http://hl7.org/fhir/StructureDefinition/Device",
"http://hl7.org/fhir/StructureDefinition/Specimen",
"http://hl7.org/fhir/StructureDefinition/Location"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.subject"
},
{
"identity" : "w5",
"map" : "FiveWs.subject[x]"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=\"SUBJ\"]???"
},
{
"identity" : "dicom",
"map" : "~0010,0020"
},
{
"identity" : "w5",
"map" : "FiveWs.subject"
}]
},
{
"id" : "Media.encounter",
"path" : "Media.encounter",
"short" : "Encounter associated with media",
"definition" : "The encounter that establishes the context for this media.",
"comment" : "This will typically be the encounter the media occurred within.",
"requirements" : "Links the Media to the Encounter context.",
"alias" : ["context"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Encounter"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.encounter"
},
{
"identity" : "w5",
"map" : "FiveWs.context"
},
{
"identity" : "rim",
"map" : ".inboundRelationship(typeCode=COMP].source[classCode<=PCPR, moodCode=EVN]"
}]
},
{
"id" : "Media.created[x]",
"path" : "Media.created[x]",
"short" : "When Media was collected",
"definition" : "The date and time(s) at which the media was collected.",
"alias" : ["timing"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "dateTime"
},
{
"code" : "Period"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.occurrence[x]"
},
{
"identity" : "w5",
"map" : "FiveWs.done[x]"
},
{
"identity" : "rim",
"map" : ".effectiveTime"
}]
},
{
"id" : "Media.issued",
"path" : "Media.issued",
"short" : "Date/Time this version was made available",
"definition" : "The date and time this version of the media was made available to providers, typically after having been reviewed.",
"comment" : "It may be the same as the [`lastUpdated` ](resource-definitions.html#Meta.lastUpdated) time of the resource itself. For Observations that do require review and verification for certain updates, it might not be the same as the `lastUpdated` time of the resource itself due to a non-clinically significant update that does not require the new version to be reviewed and verified again.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "instant"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.recorded"
},
{
"identity" : "v2",
"map" : "OBR.22 (or MSH.7), or perhaps OBX-19 (depends on who observation made)"
},
{
"identity" : "rim",
"map" : "participation[typeCode=AUT].time"
}]
},
{
"id" : "Media.operator",
"path" : "Media.operator",
"short" : "The person who generated the image",
"definition" : "The person who administered the collection of the image.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Organization",
"http://hl7.org/fhir/StructureDefinition/CareTeam",
"http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Device",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.performer.actor"
},
{
"identity" : "w5",
"map" : "FiveWs.actor"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=\"PERF\"]???"
},
{
"identity" : "dicom",
"map" : "0008,1060?"
}]
},
{
"id" : "Media.reasonCode",
"path" : "Media.reasonCode",
"short" : "Why was event performed?",
"definition" : "Describes why the event occurred in coded or textual form.",
"comment" : "Textual reasons can be captured using reasonCode.text.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MediaReason"
}],
"strength" : "example",
"description" : "The reason for the media.",
"valueSet" : "http://hl7.org/fhir/ValueSet/procedure-reason"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.reasonCode"
},
{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "rim",
"map" : ".reasonCode"
}]
},
{
"id" : "Media.bodySite",
"path" : "Media.bodySite",
"short" : "Observed body part",
"definition" : "Indicates the site on the subject's body where the observation was made (i.e. the target site).",
"comment" : "Only used if not implicit in code found in Observation.code. In many systems, this may be represented as a related observation instead of an inline component. \n\nIf the use case requires BodySite to be handled as a separate resource (e.g. to identify and track separately) then use the standard extension[ bodySite](extension-bodysite.html).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "BodySite"
}],
"strength" : "example",
"description" : "Codes describing anatomical locations. May include laterality.",
"valueSet" : "http://hl7.org/fhir/ValueSet/body-site"
},
"mapping" : [{
"identity" : "sct-concept",
"map" : "< 123037004 |Body structure|"
},
{
"identity" : "rim",
"map" : "targetSiteCode"
},
{
"identity" : "sct-attr",
"map" : "718497002 |Inherent location|"
}]
},
{
"id" : "Media.deviceName",
"path" : "Media.deviceName",
"short" : "Name of the device/manufacturer",
"definition" : "The name of the device / manufacturer of the device that was used to make the recording.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : ".participation[typeCode=\"DEV\"].role.player.Entity[classCode=\"DEV\"].name"
},
{
"identity" : "dicom",
"map" : "0008,0070"
}]
},
{
"id" : "Media.device",
"path" : "Media.device",
"short" : "Observing Device",
"definition" : "The device used to collect the media.",
"comment" : "An extension should be used if further typing of the device is needed. Secondary devices used to support collecting a media can be represented using either extension or through the Observation.related element.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Device",
"http://hl7.org/fhir/StructureDefinition/DeviceMetric",
"http://hl7.org/fhir/StructureDefinition/Device"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "sct-concept",
"map" : "< 49062001 |Device|"
},
{
"identity" : "rim",
"map" : "participation[typeCode=DEV]"
},
{
"identity" : "sct-attr",
"map" : "424226004 |Using device|"
}]
},
{
"id" : "Media.height",
"path" : "Media.height",
"short" : "Height of the image in pixels (photo/video)",
"definition" : "Height of the image in pixels (photo/video).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "positiveInt"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=\"COMP].target[classCode=\"OBS\", moodCode=\"EVN\",code=\"\"].value"
},
{
"identity" : "dicom",
"map" : "0028,0010"
}]
},
{
"id" : "Media.width",
"path" : "Media.width",
"short" : "Width of the image in pixels (photo/video)",
"definition" : "Width of the image in pixels (photo/video).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "positiveInt"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=\"COMP].target[classCode=\"OBS\", moodCode=\"EVN\",code=\"\"].value"
},
{
"identity" : "dicom",
"map" : "0028,0011"
}]
},
{
"id" : "Media.frames",
"path" : "Media.frames",
"short" : "Number of frames if > 1 (photo)",
"definition" : "The number of frames in a photo. This is used with a multi-page fax, or an imaging acquisition context that takes multiple slices in a single image, or an animated gif. If there is more than one frame, this SHALL have a value in order to alert interface software that a multi-frame capable rendering widget is required.",
"comment" : "if the number of frames is not supplied, the value may be unknown. Applications should not assume that there is only one frame unless it is explicitly stated.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "positiveInt"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=\"COMP].target[classCode=\"OBS\", moodCode=\"EVN\",code=\"\"].value"
}]
},
{
"id" : "Media.duration",
"path" : "Media.duration",
"short" : "Length in seconds (audio / video)",
"definition" : "The duration of the recording in seconds - for audio and video.",
"comment" : "The duration might differ from occurrencePeriod if recording was paused.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "decimal"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=\"COMP].target[classCode=\"OBS\", moodCode=\"EVN\",code=\"\"].value"
},
{
"identity" : "dicom",
"map" : "~0028,0002"
}]
},
{
"id" : "Media.content",
"path" : "Media.content",
"short" : "Actual Media - reference or data",
"definition" : "The actual content of the media - inline or by direct reference to the media source file.",
"comment" : "Recommended content types: image/jpeg, image/png, image/tiff, video/mpeg, audio/mp4, application/dicom. Application/dicom can contain the transfer syntax as a parameter. For media that covers a period of time (video/sound), the content.creationTime is the end time. Creation time is used for tracking, organizing versions and searching.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "Attachment"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : ".text"
}]
},
{
"id" : "Media.note",
"path" : "Media.note",
"short" : "Comments made about the media",
"definition" : "Comments made about the media by the performer, subject or other participants.",
"comment" : "Not to be used for observations, conclusions, etc. Instead use an [Observation](observation.html) based on the Media/ImagingStudy resource.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Annotation"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Event.note"
},
{
"identity" : "v2",
"map" : "NTE"
},
{
"identity" : "rim",
"map" : ".inboundRelationship(typeCode=SUBJ].source[classCode=ANNGEN, moodCode=EVN].value[xsi:type=ST]"
}]
}]
}
}
},
{
"fullUrl" : "http://hl7.org/fhir/StructureDefinition/Medication",
"resource" : {
"resourceType" : "StructureDefinition",
"id" : "Medication",
"meta" : {
"lastUpdated" : "2019-11-01T09:29:23.356+11:00"
},
"text" : {
"status" : "generated",
"div" : "Name Flags Card. Type Description & Constraints ![\".\"](\"data:)
Medication TU DomainResource Definition of a Medication
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension identifier Σ 0..* Identifier Business identifier for this medication
code Σ 0..1 CodeableConcept Codes that identify this medication
SNOMED CT Medication Codes (Example) status ?!Σ 0..1 code active | inactive | entered-in-error
Medication status codes (Required) manufacturer Σ 0..1 Reference(Organization) Manufacturer of the item form 0..1 CodeableConcept powder | tablets | capsule +
SNOMED CT Form Codes (Example) amount Σ 0..1 Ratio Amount of drug in package ingredient 0..* BackboneElement Active or inactive ingredient
item[x] 1..1 The actual ingredient or content itemCodeableConcept CodeableConcept itemReference Reference(Substance | Medication) isActive 0..1 boolean Active ingredient indicator strength 0..1 Ratio Quantity of ingredient present batch 0..1 BackboneElement Details about packaged medications lotNumber 0..1 string Identifier assigned to batch expirationDate 0..1 dateTime When batch will expire
Documentation for this format
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Clinical.Medications"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 3
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "business"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "phx"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/Medication",
"version" : "4.0.1",
"name" : "Medication",
"status" : "draft",
"date" : "2019-11-01T09:29:23+11:00",
"publisher" : "Health Level Seven International (Pharmacy)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/medication/index.cfm"
}]
}],
"description" : "This resource is primarily used for the identification and definition of a medication for the purposes of prescribing, dispensing, and administering a medication as well as for making statements about medication use.",
"fhirVersion" : "4.0.1",
"mapping" : [{
"identity" : "script10.6",
"uri" : "http://ncpdp.org/SCRIPT10_6",
"name" : "Mapping to NCPDP SCRIPT 10.6"
},
{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/fivews",
"name" : "FiveWs Pattern Mapping"
},
{
"identity" : "v2",
"uri" : "http://hl7.org/v2",
"name" : "HL7 v2 Mapping"
}],
"kind" : "resource",
"abstract" : false,
"type" : "Medication",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "Medication",
"path" : "Medication",
"short" : "Definition of a Medication",
"definition" : "This resource is primarily used for the identification and definition of a medication for the purposes of prescribing, dispensing, and administering a medication as well as for making statements about medication use.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Medication",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "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",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.`div`.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "script10.6",
"map" : "NewRx/MedicationPrescribed\r-or-\rRxFill/MedicationDispensed\r-or-\rRxHistoryResponse/MedicationDispensed\r-or-\rRxHistoryResponse/MedicationPrescribed"
},
{
"identity" : "rim",
"map" : "ManufacturedProduct[classCode=ADMM]"
}]
},
{
"id" : "Medication.id",
"path" : "Medication.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Medication.meta",
"path" : "Medication.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Medication.implicitRules",
"path" : "Medication.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "Medication.language",
"path" : "Medication.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "Medication.text",
"path" : "Medication.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "Medication.contained",
"path" : "Medication.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Medication.extension",
"path" : "Medication.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Medication.modifierExtension",
"path" : "Medication.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Medication.identifier",
"path" : "Medication.identifier",
"short" : "Business identifier for this medication",
"definition" : "Business identifier for this medication.",
"comment" : "The serial number could be included as an identifier.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Medication.identifier",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Identifier"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "rim",
"map" : ".id"
}]
},
{
"id" : "Medication.code",
"path" : "Medication.code",
"short" : "Codes that identify this medication",
"definition" : "A code (or set of codes) that specify this medication, or a textual description if no code is available. Usage note: This could be a standard medication code such as a code from RxNorm, SNOMED CT, IDMP etc. It could also be a national or local formulary code, optionally with translations to other code systems.",
"comment" : "Depending on the context of use, the code that was actually selected by the user (prescriber, dispenser, etc.) will have the coding.userSelected set to true. As described in the coding datatype: \"A coding may be marked as a \"userSelected\" if a user selected the particular coded value in a user interface (e.g. the user selects an item in a pick-list). If a user selected coding exists, it is the preferred choice for performing translations etc. Other codes can only be literal translations to alternative code systems, or codes at a lower level of granularity (e.g. a generic code for a vendor-specific primary one).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Medication.code",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MedicationFormalRepresentation"
}],
"strength" : "example",
"description" : "A coded concept that defines the type of a medication.",
"valueSet" : "http://hl7.org/fhir/ValueSet/medication-codes"
},
"mapping" : [{
"identity" : "script10.6",
"map" : "coding.code = //element(*,MedicationType)/DrugCoded/ProductCode\r\rcoding.system = //element(*,MedicationType)/DrugCoded/ProductCodeQualifier\r\rcoding.display = //element(*,MedicationType)/DrugDescription"
},
{
"identity" : "w5",
"map" : "FiveWs.class"
},
{
"identity" : "v2",
"map" : "RXO-1.1-Requested Give Code.code / RXE-2.1-Give Code.code / RXD-2.1-Dispense/Give Code.code / RXG-4.1-Give Code.code /RXA-5.1-Administered Code.code / RXC-2.1 Component Code"
},
{
"identity" : "rim",
"map" : ".code"
}]
},
{
"id" : "Medication.status",
"path" : "Medication.status",
"short" : "active | inactive | entered-in-error",
"definition" : "A code to indicate if the medication is in active use.",
"comment" : "This status is intended to identify if the medication in a local system is in active use within a drug database or inventory. For example, a pharmacy system may create a new drug file record for a compounded product \"ABC Hospital Special Cream\" with an active status. At some point in the future, it may be determined that the drug record was created with an error and the status is changed to \"entered in error\". This status is not intended to specify if a medication is part of a particular formulary. It is possible that the drug record may be referenced by multiple formularies or catalogues and each of those entries would have a separate status.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Medication.status",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element changes the interpretation of all descriptive attributes.",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MedicationStatus"
}],
"strength" : "required",
"description" : "A coded concept defining if the medication is in active use.",
"valueSet" : "http://hl7.org/fhir/ValueSet/medication-status|4.0.1"
},
"mapping" : [{
"identity" : "rim",
"map" : ".statusCode"
}]
},
{
"id" : "Medication.manufacturer",
"path" : "Medication.manufacturer",
"short" : "Manufacturer of the item",
"definition" : "Describes the details of the manufacturer of the medication product. This is not intended to represent the distributor of a medication product.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Medication.manufacturer",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "script10.6",
"map" : "no mapping"
},
{
"identity" : "w5",
"map" : "FiveWs.actor"
},
{
"identity" : "v2",
"map" : "RXD-20-Substance Manufacturer Name / RXG-21-Substance Manufacturer Name / RXA-17-Substance Manufacturer Name"
},
{
"identity" : "rim",
"map" : ".player.scopingRole[typeCode=MANU].scoper"
}]
},
{
"id" : "Medication.form",
"path" : "Medication.form",
"short" : "powder | tablets | capsule +",
"definition" : "Describes the form of the item. Powder; tablets; capsule.",
"comment" : "When Medication is referenced from MedicationRequest, this is the ordered form. When Medication is referenced within MedicationDispense, this is the dispensed form. When Medication is referenced within MedicationAdministration, this is administered form.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Medication.form",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MedicationForm"
}],
"strength" : "example",
"description" : "A coded concept defining the form of a medication.",
"valueSet" : "http://hl7.org/fhir/ValueSet/medication-form-codes"
},
"mapping" : [{
"identity" : "script10.6",
"map" : "coding.code = //element(*,DrugCodedType)/FormCode\r\rcoding.system = //element(*,DrugCodedType)/FormSourceCode"
},
{
"identity" : "v2",
"map" : "RXO-5-Requested Dosage Form / RXE-6-Give Dosage Form / RXD-6-Actual Dosage Form / RXG-8-Give Dosage Form / RXA-8-Administered Dosage Form"
},
{
"identity" : "rim",
"map" : ".formCode"
}]
},
{
"id" : "Medication.amount",
"path" : "Medication.amount",
"short" : "Amount of drug in package",
"definition" : "Specific amount of the drug in the packaged product. For example, when specifying a product that has the same strength (For example, Insulin glargine 100 unit per mL solution for injection), this attribute provides additional clarification of the package amount (For example, 3 mL, 10mL, etc.).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Medication.amount",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Ratio"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : ".quantity"
}]
},
{
"id" : "Medication.ingredient",
"path" : "Medication.ingredient",
"short" : "Active or inactive ingredient",
"definition" : "Identifies a particular constituent of interest in the product.",
"comment" : "The ingredients need not be a complete list. If an ingredient is not specified, this does not indicate whether an ingredient is present or absent. If an ingredient is specified it does not mean that all ingredients are specified. It is possible to specify both inactive and active ingredients.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Medication.ingredient",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".scopesRole[typeCode=INGR]"
}]
},
{
"id" : "Medication.ingredient.id",
"path" : "Medication.ingredient.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Medication.ingredient.extension",
"path" : "Medication.ingredient.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Medication.ingredient.modifierExtension",
"path" : "Medication.ingredient.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Medication.ingredient.item[x]",
"path" : "Medication.ingredient.item[x]",
"short" : "The actual ingredient or content",
"definition" : "The actual ingredient - either a substance (simple ingredient) or another medication of a medication.",
"requirements" : "The ingredient may reference a substance (for example, amoxicillin) or another medication (for example in the case of a compounded product, Glaxal Base).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Medication.ingredient.item[x]",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
},
{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Substance",
"http://hl7.org/fhir/StructureDefinition/Medication"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "script10.6",
"map" : "coding.code = //element(*,MedicationType)/DrugCoded/ProductCode\r\rcoding.system = //element(*,MedicationType)/DrugCoded/ProductCodeQualifier\r\rcoding.display = //element(*,MedicationType)/DrugDescription"
},
{
"identity" : "v2",
"map" : "RXC-2-Component Code if medication: RXO-1-Requested Give Code / RXE-2-Give Code / RXD-2-Dispense/Give Code / RXG-4-Give Code / RXA-5-Administered Code"
},
{
"identity" : "rim",
"map" : ".player"
}]
},
{
"id" : "Medication.ingredient.isActive",
"path" : "Medication.ingredient.isActive",
"short" : "Active ingredient indicator",
"definition" : "Indication of whether this ingredient affects the therapeutic action of the drug.",
"requirements" : "True indicates that the ingredient affects the therapeutic action of the drug (i.e. active). \rFalse indicates that the ingredient does not affect the therapeutic action of the drug (i.e. inactive).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Medication.ingredient.isActive",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "NA"
}]
},
{
"id" : "Medication.ingredient.strength",
"path" : "Medication.ingredient.strength",
"short" : "Quantity of ingredient present",
"definition" : "Specifies how many (or how much) of the items there are in this Medication. For example, 250 mg per tablet. This is expressed as a ratio where the numerator is 250mg and the denominator is 1 tablet.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Medication.ingredient.strength",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Ratio"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "script10.6",
"map" : "//element(*,DrugCodedType)/Strength"
},
{
"identity" : "v2",
"map" : "RXC-3-Component Amount & RXC-4-Component Units if medication: RXO-2-Requested Give Amount - Minimum & RXO-4-Requested Give Units / RXO-3-Requested Give Amount - Maximum & RXO-4-Requested Give Units / RXO-11-Requested Dispense Amount & RXO-12-Requested Dispense Units / RXE-3-Give Amount - Minimum & RXE-5-Give Units / RXE-4-Give Amount - Maximum & RXE-5-Give Units / RXE-10-Dispense Amount & RXE-10-Dispense Units"
},
{
"identity" : "rim",
"map" : ".quantity"
}]
},
{
"id" : "Medication.batch",
"path" : "Medication.batch",
"short" : "Details about packaged medications",
"definition" : "Information that only applies to packages (not products).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Medication.batch",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "script10.6",
"map" : "no mapping"
},
{
"identity" : "rim",
"map" : ".player[classCode=CONT]"
}]
},
{
"id" : "Medication.batch.id",
"path" : "Medication.batch.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Medication.batch.extension",
"path" : "Medication.batch.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Medication.batch.modifierExtension",
"path" : "Medication.batch.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Medication.batch.lotNumber",
"path" : "Medication.batch.lotNumber",
"short" : "Identifier assigned to batch",
"definition" : "The assigned lot number of a batch of the specified product.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Medication.batch.lotNumber",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "script10.6",
"map" : "no mapping"
},
{
"identity" : "v2",
"map" : "RXA-15 Substance Lot Number / RXG-19 Substance Lot Number"
},
{
"identity" : "rim",
"map" : ".id"
}]
},
{
"id" : "Medication.batch.expirationDate",
"path" : "Medication.batch.expirationDate",
"short" : "When batch will expire",
"definition" : "When this specific batch of product will expire.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Medication.batch.expirationDate",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "script10.6",
"map" : "no mapping"
},
{
"identity" : "v2",
"map" : "RXA-16 Substance Expiration Date / RXG-20 Substance Expiration Date"
},
{
"identity" : "rim",
"map" : "participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].expirationTime"
}]
}]
},
"differential" : {
"element" : [{
"id" : "Medication",
"path" : "Medication",
"short" : "Definition of a Medication",
"definition" : "This resource is primarily used for the identification and definition of a medication for the purposes of prescribing, dispensing, and administering a medication as well as for making statements about medication use.",
"min" : 0,
"max" : "*",
"mapping" : [{
"identity" : "script10.6",
"map" : "NewRx/MedicationPrescribed\r-or-\rRxFill/MedicationDispensed\r-or-\rRxHistoryResponse/MedicationDispensed\r-or-\rRxHistoryResponse/MedicationPrescribed"
},
{
"identity" : "rim",
"map" : "ManufacturedProduct[classCode=ADMM]"
}]
},
{
"id" : "Medication.identifier",
"path" : "Medication.identifier",
"short" : "Business identifier for this medication",
"definition" : "Business identifier for this medication.",
"comment" : "The serial number could be included as an identifier.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Identifier"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "rim",
"map" : ".id"
}]
},
{
"id" : "Medication.code",
"path" : "Medication.code",
"short" : "Codes that identify this medication",
"definition" : "A code (or set of codes) that specify this medication, or a textual description if no code is available. Usage note: This could be a standard medication code such as a code from RxNorm, SNOMED CT, IDMP etc. It could also be a national or local formulary code, optionally with translations to other code systems.",
"comment" : "Depending on the context of use, the code that was actually selected by the user (prescriber, dispenser, etc.) will have the coding.userSelected set to true. As described in the coding datatype: \"A coding may be marked as a \"userSelected\" if a user selected the particular coded value in a user interface (e.g. the user selects an item in a pick-list). If a user selected coding exists, it is the preferred choice for performing translations etc. Other codes can only be literal translations to alternative code systems, or codes at a lower level of granularity (e.g. a generic code for a vendor-specific primary one).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MedicationFormalRepresentation"
}],
"strength" : "example",
"description" : "A coded concept that defines the type of a medication.",
"valueSet" : "http://hl7.org/fhir/ValueSet/medication-codes"
},
"mapping" : [{
"identity" : "script10.6",
"map" : "coding.code = //element(*,MedicationType)/DrugCoded/ProductCode\r\rcoding.system = //element(*,MedicationType)/DrugCoded/ProductCodeQualifier\r\rcoding.display = //element(*,MedicationType)/DrugDescription"
},
{
"identity" : "w5",
"map" : "FiveWs.class"
},
{
"identity" : "v2",
"map" : "RXO-1.1-Requested Give Code.code / RXE-2.1-Give Code.code / RXD-2.1-Dispense/Give Code.code / RXG-4.1-Give Code.code /RXA-5.1-Administered Code.code / RXC-2.1 Component Code"
},
{
"identity" : "rim",
"map" : ".code"
}]
},
{
"id" : "Medication.status",
"path" : "Medication.status",
"short" : "active | inactive | entered-in-error",
"definition" : "A code to indicate if the medication is in active use.",
"comment" : "This status is intended to identify if the medication in a local system is in active use within a drug database or inventory. For example, a pharmacy system may create a new drug file record for a compounded product \"ABC Hospital Special Cream\" with an active status. At some point in the future, it may be determined that the drug record was created with an error and the status is changed to \"entered in error\". This status is not intended to specify if a medication is part of a particular formulary. It is possible that the drug record may be referenced by multiple formularies or catalogues and each of those entries would have a separate status.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isModifier" : true,
"isModifierReason" : "This element changes the interpretation of all descriptive attributes.",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MedicationStatus"
}],
"strength" : "required",
"description" : "A coded concept defining if the medication is in active use.",
"valueSet" : "http://hl7.org/fhir/ValueSet/medication-status|4.0.1"
},
"mapping" : [{
"identity" : "rim",
"map" : ".statusCode"
}]
},
{
"id" : "Medication.manufacturer",
"path" : "Medication.manufacturer",
"short" : "Manufacturer of the item",
"definition" : "Describes the details of the manufacturer of the medication product. This is not intended to represent the distributor of a medication product.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "script10.6",
"map" : "no mapping"
},
{
"identity" : "w5",
"map" : "FiveWs.actor"
},
{
"identity" : "v2",
"map" : "RXD-20-Substance Manufacturer Name / RXG-21-Substance Manufacturer Name / RXA-17-Substance Manufacturer Name"
},
{
"identity" : "rim",
"map" : ".player.scopingRole[typeCode=MANU].scoper"
}]
},
{
"id" : "Medication.form",
"path" : "Medication.form",
"short" : "powder | tablets | capsule +",
"definition" : "Describes the form of the item. Powder; tablets; capsule.",
"comment" : "When Medication is referenced from MedicationRequest, this is the ordered form. When Medication is referenced within MedicationDispense, this is the dispensed form. When Medication is referenced within MedicationAdministration, this is administered form.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MedicationForm"
}],
"strength" : "example",
"description" : "A coded concept defining the form of a medication.",
"valueSet" : "http://hl7.org/fhir/ValueSet/medication-form-codes"
},
"mapping" : [{
"identity" : "script10.6",
"map" : "coding.code = //element(*,DrugCodedType)/FormCode\r\rcoding.system = //element(*,DrugCodedType)/FormSourceCode"
},
{
"identity" : "v2",
"map" : "RXO-5-Requested Dosage Form / RXE-6-Give Dosage Form / RXD-6-Actual Dosage Form / RXG-8-Give Dosage Form / RXA-8-Administered Dosage Form"
},
{
"identity" : "rim",
"map" : ".formCode"
}]
},
{
"id" : "Medication.amount",
"path" : "Medication.amount",
"short" : "Amount of drug in package",
"definition" : "Specific amount of the drug in the packaged product. For example, when specifying a product that has the same strength (For example, Insulin glargine 100 unit per mL solution for injection), this attribute provides additional clarification of the package amount (For example, 3 mL, 10mL, etc.).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Ratio"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : ".quantity"
}]
},
{
"id" : "Medication.ingredient",
"path" : "Medication.ingredient",
"short" : "Active or inactive ingredient",
"definition" : "Identifies a particular constituent of interest in the product.",
"comment" : "The ingredients need not be a complete list. If an ingredient is not specified, this does not indicate whether an ingredient is present or absent. If an ingredient is specified it does not mean that all ingredients are specified. It is possible to specify both inactive and active ingredients.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"mapping" : [{
"identity" : "rim",
"map" : ".scopesRole[typeCode=INGR]"
}]
},
{
"id" : "Medication.ingredient.item[x]",
"path" : "Medication.ingredient.item[x]",
"short" : "The actual ingredient or content",
"definition" : "The actual ingredient - either a substance (simple ingredient) or another medication of a medication.",
"requirements" : "The ingredient may reference a substance (for example, amoxicillin) or another medication (for example in the case of a compounded product, Glaxal Base).",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
},
{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Substance",
"http://hl7.org/fhir/StructureDefinition/Medication"]
}],
"mapping" : [{
"identity" : "script10.6",
"map" : "coding.code = //element(*,MedicationType)/DrugCoded/ProductCode\r\rcoding.system = //element(*,MedicationType)/DrugCoded/ProductCodeQualifier\r\rcoding.display = //element(*,MedicationType)/DrugDescription"
},
{
"identity" : "v2",
"map" : "RXC-2-Component Code if medication: RXO-1-Requested Give Code / RXE-2-Give Code / RXD-2-Dispense/Give Code / RXG-4-Give Code / RXA-5-Administered Code"
},
{
"identity" : "rim",
"map" : ".player"
}]
},
{
"id" : "Medication.ingredient.isActive",
"path" : "Medication.ingredient.isActive",
"short" : "Active ingredient indicator",
"definition" : "Indication of whether this ingredient affects the therapeutic action of the drug.",
"requirements" : "True indicates that the ingredient affects the therapeutic action of the drug (i.e. active). \rFalse indicates that the ingredient does not affect the therapeutic action of the drug (i.e. inactive).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "boolean"
}],
"mapping" : [{
"identity" : "rim",
"map" : "NA"
}]
},
{
"id" : "Medication.ingredient.strength",
"path" : "Medication.ingredient.strength",
"short" : "Quantity of ingredient present",
"definition" : "Specifies how many (or how much) of the items there are in this Medication. For example, 250 mg per tablet. This is expressed as a ratio where the numerator is 250mg and the denominator is 1 tablet.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Ratio"
}],
"mapping" : [{
"identity" : "script10.6",
"map" : "//element(*,DrugCodedType)/Strength"
},
{
"identity" : "v2",
"map" : "RXC-3-Component Amount & RXC-4-Component Units if medication: RXO-2-Requested Give Amount - Minimum & RXO-4-Requested Give Units / RXO-3-Requested Give Amount - Maximum & RXO-4-Requested Give Units / RXO-11-Requested Dispense Amount & RXO-12-Requested Dispense Units / RXE-3-Give Amount - Minimum & RXE-5-Give Units / RXE-4-Give Amount - Maximum & RXE-5-Give Units / RXE-10-Dispense Amount & RXE-10-Dispense Units"
},
{
"identity" : "rim",
"map" : ".quantity"
}]
},
{
"id" : "Medication.batch",
"path" : "Medication.batch",
"short" : "Details about packaged medications",
"definition" : "Information that only applies to packages (not products).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "BackboneElement"
}],
"mapping" : [{
"identity" : "script10.6",
"map" : "no mapping"
},
{
"identity" : "rim",
"map" : ".player[classCode=CONT]"
}]
},
{
"id" : "Medication.batch.lotNumber",
"path" : "Medication.batch.lotNumber",
"short" : "Identifier assigned to batch",
"definition" : "The assigned lot number of a batch of the specified product.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"mapping" : [{
"identity" : "script10.6",
"map" : "no mapping"
},
{
"identity" : "v2",
"map" : "RXA-15 Substance Lot Number / RXG-19 Substance Lot Number"
},
{
"identity" : "rim",
"map" : ".id"
}]
},
{
"id" : "Medication.batch.expirationDate",
"path" : "Medication.batch.expirationDate",
"short" : "When batch will expire",
"definition" : "When this specific batch of product will expire.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "dateTime"
}],
"mapping" : [{
"identity" : "script10.6",
"map" : "no mapping"
},
{
"identity" : "v2",
"map" : "RXA-16 Substance Expiration Date / RXG-20 Substance Expiration Date"
},
{
"identity" : "rim",
"map" : "participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].expirationTime"
}]
}]
}
}
},
{
"fullUrl" : "http://hl7.org/fhir/StructureDefinition/MedicationAdministration",
"resource" : {
"resourceType" : "StructureDefinition",
"id" : "MedicationAdministration",
"meta" : {
"lastUpdated" : "2019-11-01T09:29:23.356+11:00"
},
"text" : {
"status" : "generated",
"div" : "Name Flags Card. Type Description & Constraints MedicationAdministration TU DomainResource Administration of medication to a patient
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension identifier 0..* Identifier External identifier
instantiates Σ 0..* uri Instantiates protocol or definition
partOf Σ 0..* Reference(MedicationAdministration | Procedure) Part of referenced event
status ?!Σ 1..1 code in-progress | not-done | on-hold | completed | entered-in-error | stopped | unknown
Medication administration status codes (Required) statusReason 0..* CodeableConcept Reason administration not performed
SNOMED CT Reason Medication Not Given Codes (Example)
category 0..1 CodeableConcept Type of medication usage
Medication administration category codes (Preferred) medication[x] Σ 1..1 What was administered
SNOMED CT Medication Codes (Example) medicationCodeableConcept CodeableConcept medicationReference Reference(Medication) subject Σ 1..1 Reference(Patient | Group) Who received medication context 0..1 Reference(Encounter | EpisodeOfCare) Encounter or Episode of Care administered as part of supportingInformation 0..* Reference(Any) Additional information to support administration
effective[x] Σ 1..1 Start and end time of administration effectiveDateTime dateTime effectivePeriod Period performer Σ 0..* BackboneElement Who performed the medication administration and what they did
function 0..1 CodeableConcept Type of performance
Medication administration performer function codes (Example) actor Σ 1..1 Reference(Practitioner | PractitionerRole | Patient | RelatedPerson | Device) Who performed the medication administration reasonCode 0..* CodeableConcept Reason administration performed
Reason Medication Given Codes (Example)
reasonReference 0..* Reference(Condition | Observation | DiagnosticReport) Condition or observation that supports why the medication was administered
request 0..1 Reference(MedicationRequest) Request administration performed against device 0..* Reference(Device) Device used to administer
note 0..* Annotation Information about the administration
dosage I 0..1 BackboneElement Details of how medication was taken
+ Rule: SHALL have at least one of dosage.dose or dosage.rate[x] text 0..1 string Free text dosage instructions e.g. SIG site 0..1 CodeableConcept Body site administered to
SNOMED CT Anatomical Structure for Administration Site Codes (Example) route 0..1 CodeableConcept Path of substance into body
SNOMED CT Route Codes (Example) method 0..1 CodeableConcept How drug was administered
SNOMED CT Administration Method Codes (Example) dose 0..1 SimpleQuantity Amount of medication per dose rate[x] 0..1 Dose quantity per unit of time rateRatio Ratio rateQuantity SimpleQuantity eventHistory 0..* Reference(Provenance) A list of events of interest in the lifecycle
Documentation for this format
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Clinical.Medications"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 2
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "patient"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "phx"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/MedicationAdministration",
"version" : "4.0.1",
"name" : "MedicationAdministration",
"status" : "draft",
"date" : "2019-11-01T09:29:23+11:00",
"publisher" : "Health Level Seven International (Pharmacy)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/medication/index.cfm"
}]
}],
"description" : "Describes the event of a patient consuming or otherwise being administered a medication. This may be as simple as swallowing a tablet or it may be a long running infusion. Related resources tie this event to the authorizing prescription, and the specific encounter between patient and health care practitioner.",
"fhirVersion" : "4.0.1",
"mapping" : [{
"identity" : "workflow",
"uri" : "http://hl7.org/fhir/workflow",
"name" : "Workflow Pattern"
},
{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/fivews",
"name" : "FiveWs Pattern Mapping"
},
{
"identity" : "v2",
"uri" : "http://hl7.org/v2",
"name" : "HL7 v2 Mapping"
},
{
"identity" : "w3c.prov",
"uri" : "http://www.w3.org/ns/prov",
"name" : "W3C PROV"
}],
"kind" : "resource",
"abstract" : false,
"type" : "MedicationAdministration",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "MedicationAdministration",
"path" : "MedicationAdministration",
"short" : "Administration of medication to a patient",
"definition" : "Describes the event of a patient consuming or otherwise being administered a medication. This may be as simple as swallowing a tablet or it may be a long running infusion. Related resources tie this event to the authorizing prescription, and the specific encounter between patient and health care practitioner.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicationAdministration",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "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",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.`div`.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "workflow",
"map" : "Event"
},
{
"identity" : "rim",
"map" : "SubstanceAdministration"
}]
},
{
"id" : "MedicationAdministration.id",
"path" : "MedicationAdministration.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicationAdministration.meta",
"path" : "MedicationAdministration.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicationAdministration.implicitRules",
"path" : "MedicationAdministration.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "MedicationAdministration.language",
"path" : "MedicationAdministration.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "MedicationAdministration.text",
"path" : "MedicationAdministration.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "MedicationAdministration.contained",
"path" : "MedicationAdministration.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MedicationAdministration.extension",
"path" : "MedicationAdministration.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MedicationAdministration.modifierExtension",
"path" : "MedicationAdministration.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MedicationAdministration.identifier",
"path" : "MedicationAdministration.identifier",
"short" : "External identifier",
"definition" : "Identifiers associated with this Medication Administration that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server.",
"comment" : "This is a business identifier, not a resource identifier.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicationAdministration.identifier",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Identifier"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.identifier"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "rim",
"map" : ".id"
}]
},
{
"id" : "MedicationAdministration.instantiates",
"path" : "MedicationAdministration.instantiates",
"short" : "Instantiates protocol or definition",
"definition" : "A protocol, guideline, orderset, or other definition that was adhered to in whole or in part by this event.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicationAdministration.instantiates",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.instantiates"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=DEFN].target[classCode=unspecified]"
}]
},
{
"id" : "MedicationAdministration.partOf",
"path" : "MedicationAdministration.partOf",
"short" : "Part of referenced event",
"definition" : "A larger event of which this particular event is a component or step.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicationAdministration.partOf",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/MedicationAdministration",
"http://hl7.org/fhir/StructureDefinition/Procedure"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.partOf"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=COMP]/target[classCode=SBADM or PROC,moodCode=EVN]"
}]
},
{
"id" : "MedicationAdministration.status",
"path" : "MedicationAdministration.status",
"short" : "in-progress | not-done | on-hold | completed | entered-in-error | stopped | unknown",
"definition" : "Will generally be set to show that the administration has been completed. For some long running administrations such as infusions, it is possible for an administration to be started but not completed or it may be paused while some other process is under way.",
"comment" : "This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "MedicationAdministration.status",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MedicationAdministrationStatus"
}],
"strength" : "required",
"description" : "A set of codes indicating the current status of a MedicationAdministration.",
"valueSet" : "http://hl7.org/fhir/ValueSet/medication-admin-status|4.0.1"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.status"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
},
{
"identity" : "v2",
"map" : "RXA-20-Completion Status"
},
{
"identity" : "rim",
"map" : ".statusCode"
}]
},
{
"id" : "MedicationAdministration.statusReason",
"path" : "MedicationAdministration.statusReason",
"short" : "Reason administration not performed",
"definition" : "A code indicating why the administration was not performed.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicationAdministration.statusReason",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MedicationAdministrationNegationReason"
}],
"strength" : "example",
"description" : "A set of codes indicating the reason why the MedicationAdministration is negated.",
"valueSet" : "http://hl7.org/fhir/ValueSet/reason-medication-not-given-codes"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.statusReason"
},
{
"identity" : "v2",
"map" : "RXA-9-Administration Notes / RXA-18 Substance/Treatment Refusal Reason"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=RSON]/target[classCode=OBS,moodCode=EVN, code=\"reason not given\"].value"
}]
},
{
"id" : "MedicationAdministration.category",
"path" : "MedicationAdministration.category",
"short" : "Type of medication usage",
"definition" : "Indicates where the medication is expected to be consumed or administered.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicationAdministration.category",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MedicationAdministrationCategory"
}],
"strength" : "preferred",
"description" : "A coded concept describing where the medication administered is expected to occur.",
"valueSet" : "http://hl7.org/fhir/ValueSet/medication-admin-category"
},
"mapping" : [{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=COMP].source[classCode=OBS, moodCode=EVN, code=\"type of medication usage\"].value"
}]
},
{
"id" : "MedicationAdministration.medication[x]",
"path" : "MedicationAdministration.medication[x]",
"short" : "What was administered",
"definition" : "Identifies the medication that was administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.",
"comment" : "If only a code is specified, then it needs to be a code for a specific product. If more information is required, then the use of the medication resource is recommended. For example, if you require form or lot number, then you must reference the Medication resource.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "MedicationAdministration.medication[x]",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
},
{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Medication"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MedicationCode"
}],
"strength" : "example",
"description" : "Codes identifying substance or product that can be administered.",
"valueSet" : "http://hl7.org/fhir/ValueSet/medication-codes"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.code"
},
{
"identity" : "w5",
"map" : "FiveWs.what[x]"
},
{
"identity" : "v2",
"map" : "RXA-5-Administered Code"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=CSM].role[classCode=ADMM]"
}]
},
{
"id" : "MedicationAdministration.subject",
"path" : "MedicationAdministration.subject",
"short" : "Who received medication",
"definition" : "The person or animal or group receiving the medication.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "MedicationAdministration.subject",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Group"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.subject"
},
{
"identity" : "w5",
"map" : "FiveWs.subject[x]"
},
{
"identity" : "v2",
"map" : "PID-3-Patient ID List"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=SBJ].role[classCode=PAT]"
},
{
"identity" : "w5",
"map" : "FiveWs.subject"
}]
},
{
"id" : "MedicationAdministration.context",
"path" : "MedicationAdministration.context",
"short" : "Encounter or Episode of Care administered as part of",
"definition" : "The visit, admission, or other contact between patient and health care provider during which the medication administration was performed.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicationAdministration.context",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Encounter",
"http://hl7.org/fhir/StructureDefinition/EpisodeOfCare"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.context"
},
{
"identity" : "w5",
"map" : "FiveWs.context"
},
{
"identity" : "v2",
"map" : "PV1-19-Visit Number"
},
{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN, code=\"type of encounter or episode\"]"
}]
},
{
"id" : "MedicationAdministration.supportingInformation",
"path" : "MedicationAdministration.supportingInformation",
"short" : "Additional information to support administration",
"definition" : "Additional information (for example, patient height and weight) that supports the administration of the medication.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicationAdministration.supportingInformation",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.context"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=PERT].target[A_SupportingClinicalStatement CMET minimal with many different choices of classCodes(ORG, ENC, PROC, SPLY, SBADM, OBS) and each of the act class codes draws from one or more of the following moodCodes (EVN, DEF, INT PRMS, RQO, PRP, APT, ARQ, GOL)]"
}]
},
{
"id" : "MedicationAdministration.effective[x]",
"path" : "MedicationAdministration.effective[x]",
"short" : "Start and end time of administration",
"definition" : "A specific date/time or interval of time during which the administration took place (or did not take place, when the 'notGiven' attribute is true). For many administrations, such as swallowing a tablet the use of dateTime is more appropriate.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "MedicationAdministration.effective[x]",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
},
{
"code" : "Period"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.occurrence[x]"
},
{
"identity" : "w5",
"map" : "FiveWs.done[x]"
},
{
"identity" : "v2",
"map" : "RXA-3-Date/Time Start of Administration / RXA-4-Date/Time End of Administration"
},
{
"identity" : "rim",
"map" : ".effectiveTime"
}]
},
{
"id" : "MedicationAdministration.performer",
"path" : "MedicationAdministration.performer",
"short" : "Who performed the medication administration and what they did",
"definition" : "Indicates who or what performed the medication administration and how they were involved.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicationAdministration.performer",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.performer"
},
{
"identity" : "w5",
"map" : "FiveWs.actor"
},
{
"identity" : "v2",
"map" : "RXA-10-Administering Provider / PRT-5-Participation Person: PRT-4-Participation='AP' (RXA-10 is deprecated)"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=PRF]"
}]
},
{
"id" : "MedicationAdministration.performer.id",
"path" : "MedicationAdministration.performer.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MedicationAdministration.performer.extension",
"path" : "MedicationAdministration.performer.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MedicationAdministration.performer.modifierExtension",
"path" : "MedicationAdministration.performer.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MedicationAdministration.performer.function",
"path" : "MedicationAdministration.performer.function",
"short" : "Type of performance",
"definition" : "Distinguishes the type of involvement of the performer in the medication administration.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicationAdministration.performer.function",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MedicationAdministrationPerformerFunction"
}],
"strength" : "example",
"description" : "A code describing the role an individual played in administering the medication.",
"valueSet" : "http://hl7.org/fhir/ValueSet/med-admin-perform-function"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.performer.function"
},
{
"identity" : "rim",
"map" : "participation[typeCode=PRF].functionCode"
}]
},
{
"id" : "MedicationAdministration.performer.actor",
"path" : "MedicationAdministration.performer.actor",
"short" : "Who performed the medication administration",
"definition" : "Indicates who or what performed the medication administration.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "MedicationAdministration.performer.actor",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson",
"http://hl7.org/fhir/StructureDefinition/Device"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.performer.actor"
},
{
"identity" : "rim",
"map" : ".role"
}]
},
{
"id" : "MedicationAdministration.reasonCode",
"path" : "MedicationAdministration.reasonCode",
"short" : "Reason administration performed",
"definition" : "A code indicating why the medication was given.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicationAdministration.reasonCode",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MedicationAdministrationReason"
}],
"strength" : "example",
"description" : "A set of codes indicating the reason why the MedicationAdministration was made.",
"valueSet" : "http://hl7.org/fhir/ValueSet/reason-medication-given-codes"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.reasonCode"
},
{
"identity" : "v2",
"map" : "RXE-27 Give Indication"
},
{
"identity" : "rim",
"map" : ".reasonCode"
}]
},
{
"id" : "MedicationAdministration.reasonReference",
"path" : "MedicationAdministration.reasonReference",
"short" : "Condition or observation that supports why the medication was administered",
"definition" : "Condition or observation that supports why the medication was administered.",
"comment" : "This is a reference to a condition that is the reason for the medication request. If only a code exists, use reasonCode.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicationAdministration.reasonReference",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Condition",
"http://hl7.org/fhir/StructureDefinition/Observation",
"http://hl7.org/fhir/StructureDefinition/DiagnosticReport"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.reasonReference"
},
{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=RSON]/target[classCode=OBS,moodCode=EVN, code=\"reason for use ASSERTION\"].value"
},
{
"identity" : "w3c.prov",
"map" : "no mapping"
}]
},
{
"id" : "MedicationAdministration.request",
"path" : "MedicationAdministration.request",
"short" : "Request administration performed against",
"definition" : "The original request, instruction or authority to perform the administration.",
"comment" : "This is a reference to the MedicationRequest where the intent is either order or instance-order. It should not reference MedicationRequests where the intent is any other value.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicationAdministration.request",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/MedicationRequest"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.basedOn"
},
{
"identity" : "v2",
"map" : "ORC-2-Placer Order Number / ORC-3-Filler Order Number"
},
{
"identity" : "rim",
"map" : "InFullfillmentOf->SubstanceAdministration"
}]
},
{
"id" : "MedicationAdministration.device",
"path" : "MedicationAdministration.device",
"short" : "Device used to administer",
"definition" : "The device used in administering the medication to the patient. For example, a particular infusion pump.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicationAdministration.device",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Device"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "PRT-10 Participation Device / RXR-3 Administrative Device"
},
{
"identity" : "rim",
"map" : "device->Access OR device->AssignedDevice"
}]
},
{
"id" : "MedicationAdministration.note",
"path" : "MedicationAdministration.note",
"short" : "Information about the administration",
"definition" : "Extra information about the medication administration that is not conveyed by the other attributes.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicationAdministration.note",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Annotation"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.note"
},
{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=SUBJ]/source[classCode=OBS,moodCode=EVN,code=\"annotation\"].value"
}]
},
{
"id" : "MedicationAdministration.dosage",
"path" : "MedicationAdministration.dosage",
"short" : "Details of how medication was taken",
"definition" : "Describes the medication dosage information details e.g. dose, rate, site, route, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicationAdministration.dosage",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "mad-1",
"severity" : "error",
"human" : "SHALL have at least one of dosage.dose or dosage.rate[x]",
"expression" : "dose.exists() or rate.exists()",
"xpath" : "exists(f:dose) or exists(f:*[starts-with(local-name(.), 'rate')])"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "component->SubstanceAdministrationEvent"
}]
},
{
"id" : "MedicationAdministration.dosage.id",
"path" : "MedicationAdministration.dosage.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MedicationAdministration.dosage.extension",
"path" : "MedicationAdministration.dosage.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MedicationAdministration.dosage.modifierExtension",
"path" : "MedicationAdministration.dosage.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MedicationAdministration.dosage.text",
"path" : "MedicationAdministration.dosage.text",
"short" : "Free text dosage instructions e.g. SIG",
"definition" : "Free text dosage can be used for cases where the dosage administered is too complex to code. When coded dosage is present, the free text dosage may still be present for display to humans.\r\rThe dosage instructions should reflect the dosage of the medication that was administered.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicationAdministration.dosage.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".text"
}]
},
{
"id" : "MedicationAdministration.dosage.site",
"path" : "MedicationAdministration.dosage.site",
"short" : "Body site administered to",
"definition" : "A coded specification of the anatomic site where the medication first entered the body. For example, \"left arm\".",
"comment" : "If the use case requires attributes from the BodySite resource (e.g. to identify and track separately) then use the standard extension [bodySite](extension-bodysite.html). May be a summary code, or a reference to a very precise definition of the location, or both.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicationAdministration.dosage.site",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MedicationAdministrationSite"
}],
"strength" : "example",
"description" : "A coded concept describing the site location the medicine enters into or onto the body.",
"valueSet" : "http://hl7.org/fhir/ValueSet/approach-site-codes"
},
"mapping" : [{
"identity" : "v2",
"map" : "RXR-2 Administration Site / RXR-6 Administration Site Modifier"
},
{
"identity" : "rim",
"map" : ".approachSiteCode"
}]
},
{
"id" : "MedicationAdministration.dosage.route",
"path" : "MedicationAdministration.dosage.route",
"short" : "Path of substance into body",
"definition" : "A code specifying the route or physiological path of administration of a therapeutic agent into or onto the patient. For example, topical, intravenous, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicationAdministration.dosage.route",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "RouteOfAdministration"
}],
"strength" : "example",
"description" : "A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject.",
"valueSet" : "http://hl7.org/fhir/ValueSet/route-codes"
},
"mapping" : [{
"identity" : "v2",
"map" : "RXR-1-Route"
},
{
"identity" : "rim",
"map" : ".routeCode"
}]
},
{
"id" : "MedicationAdministration.dosage.method",
"path" : "MedicationAdministration.dosage.method",
"short" : "How drug was administered",
"definition" : "A coded value indicating the method by which the medication is intended to be or was introduced into or on the body. This attribute will most often NOT be populated. It is most commonly used for injections. For example, Slow Push, Deep IV.",
"comment" : "One of the reasons this attribute is not used often, is that the method is often pre-coordinated with the route and/or form of administration. This means the codes used in route or form may pre-coordinate the method in the route code or the form code. The implementation decision about what coding system to use for route or form code will determine how frequently the method code will be populated e.g. if route or form code pre-coordinate method code, then this attribute will not be populated often; if there is no pre-coordination then method code may be used frequently.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicationAdministration.dosage.method",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MedicationAdministrationMethod"
}],
"strength" : "example",
"description" : "A coded concept describing the technique by which the medicine is administered.",
"valueSet" : "http://hl7.org/fhir/ValueSet/administration-method-codes"
},
"mapping" : [{
"identity" : "v2",
"map" : "RXR-4-Administration Method"
},
{
"identity" : "rim",
"map" : ".methodCode"
}]
},
{
"id" : "MedicationAdministration.dosage.dose",
"path" : "MedicationAdministration.dosage.dose",
"short" : "Amount of medication per dose",
"definition" : "The amount of the medication given at one administration event. Use this value when the administration is essentially an instantaneous event such as a swallowing a tablet or giving an injection.",
"comment" : "If the administration is not instantaneous (rate is present), this can be specified to convey the total amount administered over period of time of a single administration.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicationAdministration.dosage.dose",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Quantity",
"profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "RXA-6 Administered Amount / RXA-7 Administered Units"
},
{
"identity" : "rim",
"map" : ".doseQuantity"
}]
},
{
"id" : "MedicationAdministration.dosage.rate[x]",
"path" : "MedicationAdministration.dosage.rate[x]",
"short" : "Dose quantity per unit of time",
"definition" : "Identifies the speed with which the medication was or will be introduced into the patient. Typically, the rate for an infusion e.g. 100 ml per 1 hour or 100 ml/hr. May also be expressed as a rate per unit of time, e.g. 500 ml per 2 hours. Other examples: 200 mcg/min or 200 mcg/1 minute; 1 liter/8 hours.",
"comment" : "If the rate changes over time, and you want to capture this in MedicationAdministration, then each change should be captured as a distinct MedicationAdministration, with a specific MedicationAdministration.dosage.rate, and the date time when the rate change occurred. Typically, the MedicationAdministration.dosage.rate element is not used to convey an average rate.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicationAdministration.dosage.rate[x]",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Ratio"
},
{
"code" : "Quantity",
"profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "RXA-12-Administered Per (Time Unit)"
},
{
"identity" : "rim",
"map" : ".rateQuantity"
}]
},
{
"id" : "MedicationAdministration.eventHistory",
"path" : "MedicationAdministration.eventHistory",
"short" : "A list of events of interest in the lifecycle",
"definition" : "A summary of the events of interest that have occurred, such as when the administration was verified.",
"comment" : "This might not include provenances for all versions of the request – only those deemed “relevant” or important. This SHALL NOT include the Provenance associated with this current version of the resource. (If that provenance is deemed to be a “relevant” change, it will need to be added as part of a later update. Until then, it can be queried directly as the Provenance that points to this version using _revinclude All Provenances should have some historical version of this Request as their subject.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicationAdministration.eventHistory",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Provenance"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".inboundRelationship(typeCode=SUBJ].source[classCode=CACT, moodCode=EVN]"
}]
}]
},
"differential" : {
"element" : [{
"id" : "MedicationAdministration",
"path" : "MedicationAdministration",
"short" : "Administration of medication to a patient",
"definition" : "Describes the event of a patient consuming or otherwise being administered a medication. This may be as simple as swallowing a tablet or it may be a long running infusion. Related resources tie this event to the authorizing prescription, and the specific encounter between patient and health care practitioner.",
"min" : 0,
"max" : "*",
"mapping" : [{
"identity" : "workflow",
"map" : "Event"
},
{
"identity" : "rim",
"map" : "SubstanceAdministration"
}]
},
{
"id" : "MedicationAdministration.identifier",
"path" : "MedicationAdministration.identifier",
"short" : "External identifier",
"definition" : "Identifiers associated with this Medication Administration that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server.",
"comment" : "This is a business identifier, not a resource identifier.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Identifier"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Event.identifier"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "rim",
"map" : ".id"
}]
},
{
"id" : "MedicationAdministration.instantiates",
"path" : "MedicationAdministration.instantiates",
"short" : "Instantiates protocol or definition",
"definition" : "A protocol, guideline, orderset, or other definition that was adhered to in whole or in part by this event.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "uri"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.instantiates"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=DEFN].target[classCode=unspecified]"
}]
},
{
"id" : "MedicationAdministration.partOf",
"path" : "MedicationAdministration.partOf",
"short" : "Part of referenced event",
"definition" : "A larger event of which this particular event is a component or step.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/MedicationAdministration",
"http://hl7.org/fhir/StructureDefinition/Procedure"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.partOf"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=COMP]/target[classCode=SBADM or PROC,moodCode=EVN]"
}]
},
{
"id" : "MedicationAdministration.status",
"path" : "MedicationAdministration.status",
"short" : "in-progress | not-done | on-hold | completed | entered-in-error | stopped | unknown",
"definition" : "Will generally be set to show that the administration has been completed. For some long running administrations such as infusions, it is possible for an administration to be started but not completed or it may be paused while some other process is under way.",
"comment" : "This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isModifier" : true,
"isModifierReason" : "This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MedicationAdministrationStatus"
}],
"strength" : "required",
"description" : "A set of codes indicating the current status of a MedicationAdministration.",
"valueSet" : "http://hl7.org/fhir/ValueSet/medication-admin-status|4.0.1"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.status"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
},
{
"identity" : "v2",
"map" : "RXA-20-Completion Status"
},
{
"identity" : "rim",
"map" : ".statusCode"
}]
},
{
"id" : "MedicationAdministration.statusReason",
"path" : "MedicationAdministration.statusReason",
"short" : "Reason administration not performed",
"definition" : "A code indicating why the administration was not performed.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MedicationAdministrationNegationReason"
}],
"strength" : "example",
"description" : "A set of codes indicating the reason why the MedicationAdministration is negated.",
"valueSet" : "http://hl7.org/fhir/ValueSet/reason-medication-not-given-codes"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.statusReason"
},
{
"identity" : "v2",
"map" : "RXA-9-Administration Notes / RXA-18 Substance/Treatment Refusal Reason"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=RSON]/target[classCode=OBS,moodCode=EVN, code=\"reason not given\"].value"
}]
},
{
"id" : "MedicationAdministration.category",
"path" : "MedicationAdministration.category",
"short" : "Type of medication usage",
"definition" : "Indicates where the medication is expected to be consumed or administered.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MedicationAdministrationCategory"
}],
"strength" : "preferred",
"description" : "A coded concept describing where the medication administered is expected to occur.",
"valueSet" : "http://hl7.org/fhir/ValueSet/medication-admin-category"
},
"mapping" : [{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=COMP].source[classCode=OBS, moodCode=EVN, code=\"type of medication usage\"].value"
}]
},
{
"id" : "MedicationAdministration.medication[x]",
"path" : "MedicationAdministration.medication[x]",
"short" : "What was administered",
"definition" : "Identifies the medication that was administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.",
"comment" : "If only a code is specified, then it needs to be a code for a specific product. If more information is required, then the use of the medication resource is recommended. For example, if you require form or lot number, then you must reference the Medication resource.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
},
{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Medication"]
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MedicationCode"
}],
"strength" : "example",
"description" : "Codes identifying substance or product that can be administered.",
"valueSet" : "http://hl7.org/fhir/ValueSet/medication-codes"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.code"
},
{
"identity" : "w5",
"map" : "FiveWs.what[x]"
},
{
"identity" : "v2",
"map" : "RXA-5-Administered Code"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=CSM].role[classCode=ADMM]"
}]
},
{
"id" : "MedicationAdministration.subject",
"path" : "MedicationAdministration.subject",
"short" : "Who received medication",
"definition" : "The person or animal or group receiving the medication.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Group"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.subject"
},
{
"identity" : "w5",
"map" : "FiveWs.subject[x]"
},
{
"identity" : "v2",
"map" : "PID-3-Patient ID List"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=SBJ].role[classCode=PAT]"
},
{
"identity" : "w5",
"map" : "FiveWs.subject"
}]
},
{
"id" : "MedicationAdministration.context",
"path" : "MedicationAdministration.context",
"short" : "Encounter or Episode of Care administered as part of",
"definition" : "The visit, admission, or other contact between patient and health care provider during which the medication administration was performed.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Encounter",
"http://hl7.org/fhir/StructureDefinition/EpisodeOfCare"]
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Event.context"
},
{
"identity" : "w5",
"map" : "FiveWs.context"
},
{
"identity" : "v2",
"map" : "PV1-19-Visit Number"
},
{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN, code=\"type of encounter or episode\"]"
}]
},
{
"id" : "MedicationAdministration.supportingInformation",
"path" : "MedicationAdministration.supportingInformation",
"short" : "Additional information to support administration",
"definition" : "Additional information (for example, patient height and weight) that supports the administration of the medication.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.context"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=PERT].target[A_SupportingClinicalStatement CMET minimal with many different choices of classCodes(ORG, ENC, PROC, SPLY, SBADM, OBS) and each of the act class codes draws from one or more of the following moodCodes (EVN, DEF, INT PRMS, RQO, PRP, APT, ARQ, GOL)]"
}]
},
{
"id" : "MedicationAdministration.effective[x]",
"path" : "MedicationAdministration.effective[x]",
"short" : "Start and end time of administration",
"definition" : "A specific date/time or interval of time during which the administration took place (or did not take place, when the 'notGiven' attribute is true). For many administrations, such as swallowing a tablet the use of dateTime is more appropriate.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "dateTime"
},
{
"code" : "Period"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.occurrence[x]"
},
{
"identity" : "w5",
"map" : "FiveWs.done[x]"
},
{
"identity" : "v2",
"map" : "RXA-3-Date/Time Start of Administration / RXA-4-Date/Time End of Administration"
},
{
"identity" : "rim",
"map" : ".effectiveTime"
}]
},
{
"id" : "MedicationAdministration.performer",
"path" : "MedicationAdministration.performer",
"short" : "Who performed the medication administration and what they did",
"definition" : "Indicates who or what performed the medication administration and how they were involved.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.performer"
},
{
"identity" : "w5",
"map" : "FiveWs.actor"
},
{
"identity" : "v2",
"map" : "RXA-10-Administering Provider / PRT-5-Participation Person: PRT-4-Participation='AP' (RXA-10 is deprecated)"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=PRF]"
}]
},
{
"id" : "MedicationAdministration.performer.function",
"path" : "MedicationAdministration.performer.function",
"short" : "Type of performance",
"definition" : "Distinguishes the type of involvement of the performer in the medication administration.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MedicationAdministrationPerformerFunction"
}],
"strength" : "example",
"description" : "A code describing the role an individual played in administering the medication.",
"valueSet" : "http://hl7.org/fhir/ValueSet/med-admin-perform-function"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.performer.function"
},
{
"identity" : "rim",
"map" : "participation[typeCode=PRF].functionCode"
}]
},
{
"id" : "MedicationAdministration.performer.actor",
"path" : "MedicationAdministration.performer.actor",
"short" : "Who performed the medication administration",
"definition" : "Indicates who or what performed the medication administration.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson",
"http://hl7.org/fhir/StructureDefinition/Device"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.performer.actor"
},
{
"identity" : "rim",
"map" : ".role"
}]
},
{
"id" : "MedicationAdministration.reasonCode",
"path" : "MedicationAdministration.reasonCode",
"short" : "Reason administration performed",
"definition" : "A code indicating why the medication was given.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MedicationAdministrationReason"
}],
"strength" : "example",
"description" : "A set of codes indicating the reason why the MedicationAdministration was made.",
"valueSet" : "http://hl7.org/fhir/ValueSet/reason-medication-given-codes"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.reasonCode"
},
{
"identity" : "v2",
"map" : "RXE-27 Give Indication"
},
{
"identity" : "rim",
"map" : ".reasonCode"
}]
},
{
"id" : "MedicationAdministration.reasonReference",
"path" : "MedicationAdministration.reasonReference",
"short" : "Condition or observation that supports why the medication was administered",
"definition" : "Condition or observation that supports why the medication was administered.",
"comment" : "This is a reference to a condition that is the reason for the medication request. If only a code exists, use reasonCode.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Condition",
"http://hl7.org/fhir/StructureDefinition/Observation",
"http://hl7.org/fhir/StructureDefinition/DiagnosticReport"]
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Event.reasonReference"
},
{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=RSON]/target[classCode=OBS,moodCode=EVN, code=\"reason for use ASSERTION\"].value"
},
{
"identity" : "w3c.prov",
"map" : "no mapping"
}]
},
{
"id" : "MedicationAdministration.request",
"path" : "MedicationAdministration.request",
"short" : "Request administration performed against",
"definition" : "The original request, instruction or authority to perform the administration.",
"comment" : "This is a reference to the MedicationRequest where the intent is either order or instance-order. It should not reference MedicationRequests where the intent is any other value.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/MedicationRequest"]
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Event.basedOn"
},
{
"identity" : "v2",
"map" : "ORC-2-Placer Order Number / ORC-3-Filler Order Number"
},
{
"identity" : "rim",
"map" : "InFullfillmentOf->SubstanceAdministration"
}]
},
{
"id" : "MedicationAdministration.device",
"path" : "MedicationAdministration.device",
"short" : "Device used to administer",
"definition" : "The device used in administering the medication to the patient. For example, a particular infusion pump.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Device"]
}],
"mapping" : [{
"identity" : "v2",
"map" : "PRT-10 Participation Device / RXR-3 Administrative Device"
},
{
"identity" : "rim",
"map" : "device->Access OR device->AssignedDevice"
}]
},
{
"id" : "MedicationAdministration.note",
"path" : "MedicationAdministration.note",
"short" : "Information about the administration",
"definition" : "Extra information about the medication administration that is not conveyed by the other attributes.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Annotation"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Event.note"
},
{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=SUBJ]/source[classCode=OBS,moodCode=EVN,code=\"annotation\"].value"
}]
},
{
"id" : "MedicationAdministration.dosage",
"path" : "MedicationAdministration.dosage",
"short" : "Details of how medication was taken",
"definition" : "Describes the medication dosage information details e.g. dose, rate, site, route, etc.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "mad-1",
"severity" : "error",
"human" : "SHALL have at least one of dosage.dose or dosage.rate[x]",
"expression" : "dose.exists() or rate.exists()",
"xpath" : "exists(f:dose) or exists(f:*[starts-with(local-name(.), 'rate')])"
}],
"mapping" : [{
"identity" : "rim",
"map" : "component->SubstanceAdministrationEvent"
}]
},
{
"id" : "MedicationAdministration.dosage.text",
"path" : "MedicationAdministration.dosage.text",
"short" : "Free text dosage instructions e.g. SIG",
"definition" : "Free text dosage can be used for cases where the dosage administered is too complex to code. When coded dosage is present, the free text dosage may still be present for display to humans.\r\rThe dosage instructions should reflect the dosage of the medication that was administered.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"mapping" : [{
"identity" : "rim",
"map" : ".text"
}]
},
{
"id" : "MedicationAdministration.dosage.site",
"path" : "MedicationAdministration.dosage.site",
"short" : "Body site administered to",
"definition" : "A coded specification of the anatomic site where the medication first entered the body. For example, \"left arm\".",
"comment" : "If the use case requires attributes from the BodySite resource (e.g. to identify and track separately) then use the standard extension [bodySite](extension-bodysite.html). May be a summary code, or a reference to a very precise definition of the location, or both.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MedicationAdministrationSite"
}],
"strength" : "example",
"description" : "A coded concept describing the site location the medicine enters into or onto the body.",
"valueSet" : "http://hl7.org/fhir/ValueSet/approach-site-codes"
},
"mapping" : [{
"identity" : "v2",
"map" : "RXR-2 Administration Site / RXR-6 Administration Site Modifier"
},
{
"identity" : "rim",
"map" : ".approachSiteCode"
}]
},
{
"id" : "MedicationAdministration.dosage.route",
"path" : "MedicationAdministration.dosage.route",
"short" : "Path of substance into body",
"definition" : "A code specifying the route or physiological path of administration of a therapeutic agent into or onto the patient. For example, topical, intravenous, etc.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "RouteOfAdministration"
}],
"strength" : "example",
"description" : "A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject.",
"valueSet" : "http://hl7.org/fhir/ValueSet/route-codes"
},
"mapping" : [{
"identity" : "v2",
"map" : "RXR-1-Route"
},
{
"identity" : "rim",
"map" : ".routeCode"
}]
},
{
"id" : "MedicationAdministration.dosage.method",
"path" : "MedicationAdministration.dosage.method",
"short" : "How drug was administered",
"definition" : "A coded value indicating the method by which the medication is intended to be or was introduced into or on the body. This attribute will most often NOT be populated. It is most commonly used for injections. For example, Slow Push, Deep IV.",
"comment" : "One of the reasons this attribute is not used often, is that the method is often pre-coordinated with the route and/or form of administration. This means the codes used in route or form may pre-coordinate the method in the route code or the form code. The implementation decision about what coding system to use for route or form code will determine how frequently the method code will be populated e.g. if route or form code pre-coordinate method code, then this attribute will not be populated often; if there is no pre-coordination then method code may be used frequently.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MedicationAdministrationMethod"
}],
"strength" : "example",
"description" : "A coded concept describing the technique by which the medicine is administered.",
"valueSet" : "http://hl7.org/fhir/ValueSet/administration-method-codes"
},
"mapping" : [{
"identity" : "v2",
"map" : "RXR-4-Administration Method"
},
{
"identity" : "rim",
"map" : ".methodCode"
}]
},
{
"id" : "MedicationAdministration.dosage.dose",
"path" : "MedicationAdministration.dosage.dose",
"short" : "Amount of medication per dose",
"definition" : "The amount of the medication given at one administration event. Use this value when the administration is essentially an instantaneous event such as a swallowing a tablet or giving an injection.",
"comment" : "If the administration is not instantaneous (rate is present), this can be specified to convey the total amount administered over period of time of a single administration.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Quantity",
"profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
}],
"mapping" : [{
"identity" : "v2",
"map" : "RXA-6 Administered Amount / RXA-7 Administered Units"
},
{
"identity" : "rim",
"map" : ".doseQuantity"
}]
},
{
"id" : "MedicationAdministration.dosage.rate[x]",
"path" : "MedicationAdministration.dosage.rate[x]",
"short" : "Dose quantity per unit of time",
"definition" : "Identifies the speed with which the medication was or will be introduced into the patient. Typically, the rate for an infusion e.g. 100 ml per 1 hour or 100 ml/hr. May also be expressed as a rate per unit of time, e.g. 500 ml per 2 hours. Other examples: 200 mcg/min or 200 mcg/1 minute; 1 liter/8 hours.",
"comment" : "If the rate changes over time, and you want to capture this in MedicationAdministration, then each change should be captured as a distinct MedicationAdministration, with a specific MedicationAdministration.dosage.rate, and the date time when the rate change occurred. Typically, the MedicationAdministration.dosage.rate element is not used to convey an average rate.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Ratio"
},
{
"code" : "Quantity",
"profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
}],
"mapping" : [{
"identity" : "v2",
"map" : "RXA-12-Administered Per (Time Unit)"
},
{
"identity" : "rim",
"map" : ".rateQuantity"
}]
},
{
"id" : "MedicationAdministration.eventHistory",
"path" : "MedicationAdministration.eventHistory",
"short" : "A list of events of interest in the lifecycle",
"definition" : "A summary of the events of interest that have occurred, such as when the administration was verified.",
"comment" : "This might not include provenances for all versions of the request – only those deemed “relevant” or important. This SHALL NOT include the Provenance associated with this current version of the resource. (If that provenance is deemed to be a “relevant” change, it will need to be added as part of a later update. Until then, it can be queried directly as the Provenance that points to this version using _revinclude All Provenances should have some historical version of this Request as their subject.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Provenance"]
}],
"mapping" : [{
"identity" : "rim",
"map" : ".inboundRelationship(typeCode=SUBJ].source[classCode=CACT, moodCode=EVN]"
}]
}]
}
}
},
{
"fullUrl" : "http://hl7.org/fhir/StructureDefinition/MedicationDispense",
"resource" : {
"resourceType" : "StructureDefinition",
"id" : "MedicationDispense",
"meta" : {
"lastUpdated" : "2019-11-01T09:29:23.356+11:00"
},
"text" : {
"status" : "generated",
"div" : "Name Flags Card. Type Description & Constraints MedicationDispense ITU 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 identifier 0..* Identifier External identifier
partOf 0..* Reference(Procedure) Event that dispense is part of
status ?!Σ 1..1 code preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown
Medication dispense status codes (Required) statusReason[x] 0..1 Why a dispense was not performed
Medication dispense status reason codes (Example) statusReasonCodeableConcept CodeableConcept statusReasonReference Reference(DetectedIssue) category 0..1 CodeableConcept Type of medication dispense
Medication dispense category codes (Preferred) medication[x] Σ 1..1 What medication was supplied
SNOMED CT Medication Codes (Example) medicationCodeableConcept CodeableConcept medicationReference Reference(Medication) subject Σ 0..1 Reference(Patient | Group) Who the dispense is for context 0..1 Reference(Encounter | EpisodeOfCare) Encounter / Episode associated with event supportingInformation 0..* Reference(Any) Information that supports the dispensing of the medication
performer 0..* BackboneElement Who performed event
function 0..1 CodeableConcept Who performed the dispense and what they did
Medication dispense performer function codes (Example) actor 1..1 Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson) Individual who was performing location 0..1 Reference(Location) Where the dispense occurred authorizingPrescription 0..* Reference(MedicationRequest) Medication order that authorizes the dispense
type 0..1 CodeableConcept Trial fill, partial fill, emergency fill, etc.
V3 Value SetActPharmacySupplyType (Example) quantity 0..1 SimpleQuantity Amount dispensed daysSupply 0..1 SimpleQuantity Amount of medication expressed as a timing amount whenPrepared Σ 0..1 dateTime When product was packaged and reviewed whenHandedOver 0..1 dateTime When product was given out destination 0..1 Reference(Location) Where the medication was sent receiver 0..* Reference(Patient | Practitioner) Who collected the medication
note 0..* Annotation Information about the dispense
dosageInstruction 0..* Dosage How the medication is to be used by the patient or administered by the caregiver
substitution 0..1 BackboneElement Whether a substitution was performed on the dispense wasSubstituted 1..1 boolean Whether a substitution was or was not performed on the dispense type 0..1 CodeableConcept Code signifying whether a different drug was dispensed from what was prescribed
V3 Value SetActSubstanceAdminSubstitutionCode (Example) reason 0..* CodeableConcept Why was substitution made
V3 Value SetSubstanceAdminSubstitutionReason (Example)
responsibleParty 0..* Reference(Practitioner | PractitionerRole) Who is responsible for the substitution
detectedIssue 0..* Reference(DetectedIssue) Clinical issue with action
eventHistory 0..* Reference(Provenance) A list of relevant lifecycle events
Documentation for this format
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Clinical.Medications"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 2
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "patient"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "phx"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/MedicationDispense",
"version" : "4.0.1",
"name" : "MedicationDispense",
"status" : "draft",
"date" : "2019-11-01T09:29:23+11:00",
"publisher" : "Health Level Seven International (Pharmacy)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/medication/index.cfm"
}]
}],
"description" : "Indicates that a medication product is to be or has been dispensed for a named person/patient. This includes a description of the medication product (supply) provided and the instructions for administering the medication. The medication dispense is the result of a pharmacy system responding to a medication order.",
"fhirVersion" : "4.0.1",
"mapping" : [{
"identity" : "workflow",
"uri" : "http://hl7.org/fhir/workflow",
"name" : "Workflow Pattern"
},
{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/fivews",
"name" : "FiveWs Pattern Mapping"
},
{
"identity" : "rx-dispense-rmim",
"uri" : "http://www.hl7.org/v3/PORX_RM020070UV",
"name" : "V3 Pharmacy Dispense RMIM"
},
{
"identity" : "v2",
"uri" : "http://hl7.org/v2",
"name" : "HL7 v2 Mapping"
}],
"kind" : "resource",
"abstract" : false,
"type" : "MedicationDispense",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "MedicationDispense",
"path" : "MedicationDispense",
"short" : "Dispensing a medication to a named patient",
"definition" : "Indicates that a medication product is to be or has been dispensed for a named person/patient. This includes a description of the medication product (supply) provided and the instructions for administering the medication. The medication dispense is the result of a pharmacy system responding to a medication order.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicationDispense",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "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",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.`div`.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "mdd-1",
"severity" : "error",
"human" : "whenHandedOver cannot be before whenPrepared",
"expression" : "whenHandedOver.empty() or whenPrepared.empty() or whenHandedOver >= whenPrepared",
"xpath" : "not(exists(f:whenHandedOver/@value)) or not(exists(f:whenPrepared/@value)) or ( f:whenHandedOver/@value >= f:whenPrepared/@value)"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "workflow",
"map" : "Event"
},
{
"identity" : "rim",
"map" : "Supply[moodCode=EVN]"
}]
},
{
"id" : "MedicationDispense.id",
"path" : "MedicationDispense.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicationDispense.meta",
"path" : "MedicationDispense.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicationDispense.implicitRules",
"path" : "MedicationDispense.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "MedicationDispense.language",
"path" : "MedicationDispense.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "MedicationDispense.text",
"path" : "MedicationDispense.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "MedicationDispense.contained",
"path" : "MedicationDispense.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MedicationDispense.extension",
"path" : "MedicationDispense.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MedicationDispense.modifierExtension",
"path" : "MedicationDispense.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MedicationDispense.identifier",
"path" : "MedicationDispense.identifier",
"short" : "External identifier",
"definition" : "Identifiers associated with this Medication Dispense that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server.",
"comment" : "This is a business identifier, not a resource identifier.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicationDispense.identifier",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Identifier"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.identifier"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "rim",
"map" : ".id"
},
{
"identity" : "rx-dispense-rmim",
"map" : "CombinedMedicationDispense.id"
}]
},
{
"id" : "MedicationDispense.partOf",
"path" : "MedicationDispense.partOf",
"short" : "Event that dispense is part of",
"definition" : "The procedure that trigger the dispense.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicationDispense.partOf",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Procedure"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.partOf"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=COMP]/target[classCode=PROC,moodCode=EVN]"
}]
},
{
"id" : "MedicationDispense.status",
"path" : "MedicationDispense.status",
"short" : "preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown",
"definition" : "A code specifying the state of the set of dispense events.",
"comment" : "This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "MedicationDispense.status",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MedicationDispenseStatus"
}],
"strength" : "required",
"description" : "A coded concept specifying the state of the dispense event.",
"valueSet" : "http://hl7.org/fhir/ValueSet/medicationdispense-status|4.0.1"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.status"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
},
{
"identity" : "rim",
"map" : ".statusCode"
},
{
"identity" : "rx-dispense-rmim",
"map" : "CombinedMedicationDispense.SupplyEvent.statusCode"
}]
},
{
"id" : "MedicationDispense.statusReason[x]",
"path" : "MedicationDispense.statusReason[x]",
"short" : "Why a dispense was not performed",
"definition" : "Indicates the reason why a dispense was not performed.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicationDispense.statusReason[x]",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
},
{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/DetectedIssue"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MedicationDispenseStatusReason"
}],
"strength" : "example",
"description" : "A code describing why a dispense was not performed.",
"valueSet" : "http://hl7.org/fhir/ValueSet/medicationdispense-status-reason"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.statusReason"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=RSON]/target[classCode=OBS,moodCode=EVN, code=\"not done reason\"].value"
}]
},
{
"id" : "MedicationDispense.category",
"path" : "MedicationDispense.category",
"short" : "Type of medication dispense",
"definition" : "Indicates the type of medication dispense (for example, where the medication is expected to be consumed or administered (i.e. inpatient or outpatient)).",
"comment" : "The category can be used to include where the medication is expected to be consumed or other types of dispenses. Invariants can be used to bind to different value sets when profiling to bind.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicationDispense.category",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MedicationDispenseCategory"
}],
"strength" : "preferred",
"description" : "A code describing where the dispensed medication is expected to be consumed or administered.",
"valueSet" : "http://hl7.org/fhir/ValueSet/medicationdispense-category"
},
"mapping" : [{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=COMP].source[classCode=OBS, moodCode=EVN, code=\"type of medication dispense\"].value"
}]
},
{
"id" : "MedicationDispense.medication[x]",
"path" : "MedicationDispense.medication[x]",
"short" : "What medication was supplied",
"definition" : "Identifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.",
"comment" : "If only a code is specified, then it needs to be a code for a specific product. If more information is required, then the use of the medication resource is recommended. For example, if you require form or lot number, then you must reference the Medication resource.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "MedicationDispense.medication[x]",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
},
{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Medication"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MedicationCode"
}],
"strength" : "example",
"description" : "A coded concept identifying which substance or product can be dispensed.",
"valueSet" : "http://hl7.org/fhir/ValueSet/medication-codes"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.code"
},
{
"identity" : "w5",
"map" : "FiveWs.what[x]"
},
{
"identity" : "v2",
"map" : "RXD-2-Dispense/Give Code"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=PRD].role"
},
{
"identity" : "rx-dispense-rmim",
"map" : "CombinedMedicationRequest.component1.AdministrationRequest.consumable"
}]
},
{
"id" : "MedicationDispense.subject",
"path" : "MedicationDispense.subject",
"short" : "Who the dispense is for",
"definition" : "A link to a resource representing the person or the group to whom the medication will be given.",
"comment" : "SubstanceAdministration->subject->Patient.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicationDispense.subject",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Group"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.subject"
},
{
"identity" : "w5",
"map" : "FiveWs.subject[x]"
},
{
"identity" : "v2",
"map" : "PID-3-Patient ID List"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=SBJ].role[classCode=PAT]"
},
{
"identity" : "w5",
"map" : "FiveWs.subject"
}]
},
{
"id" : "MedicationDispense.context",
"path" : "MedicationDispense.context",
"short" : "Encounter / Episode associated with event",
"definition" : "The encounter or episode of care that establishes the context for this event.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicationDispense.context",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Encounter",
"http://hl7.org/fhir/StructureDefinition/EpisodeOfCare"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.context"
},
{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN, code=\"type of encounter or episode\"]"
}]
},
{
"id" : "MedicationDispense.supportingInformation",
"path" : "MedicationDispense.supportingInformation",
"short" : "Information that supports the dispensing of the medication",
"definition" : "Additional information that supports the medication being dispensed.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicationDispense.supportingInformation",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.context"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=PERT].target[A_SupportingClinicalStatement CMET minimal with many different choices of classCodes(ORG, ENC, PROC, SPLY, SBADM, OBS) and each of the act class codes draws from one or more of the following moodCodes (EVN, DEF, INT PRMS, RQO, PRP, APT, ARQ, GOL)]"
}]
},
{
"id" : "MedicationDispense.performer",
"path" : "MedicationDispense.performer",
"short" : "Who performed event",
"definition" : "Indicates who or what performed the event.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicationDispense.performer",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.performer"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=PRF]"
}]
},
{
"id" : "MedicationDispense.performer.id",
"path" : "MedicationDispense.performer.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MedicationDispense.performer.extension",
"path" : "MedicationDispense.performer.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MedicationDispense.performer.modifierExtension",
"path" : "MedicationDispense.performer.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MedicationDispense.performer.function",
"path" : "MedicationDispense.performer.function",
"short" : "Who performed the dispense and what they did",
"definition" : "Distinguishes the type of performer in the dispense. For example, date enterer, packager, final checker.",
"requirements" : "Allows disambiguation of the types of involvement of different performers.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicationDispense.performer.function",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MedicationDispensePerformerFunction"
}],
"strength" : "example",
"description" : "A code describing the role an individual played in dispensing a medication.",
"valueSet" : "http://hl7.org/fhir/ValueSet/medicationdispense-performer-function"
},
"mapping" : [{
"identity" : "rim",
"map" : "participation[typeCode=PRF].functionCode"
}]
},
{
"id" : "MedicationDispense.performer.actor",
"path" : "MedicationDispense.performer.actor",
"short" : "Individual who was performing",
"definition" : "The device, practitioner, etc. who performed the action. It should be assumed that the actor is the dispenser of the medication.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "MedicationDispense.performer.actor",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Organization",
"http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Device",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.performer.actor"
},
{
"identity" : "rim",
"map" : ".role"
}]
},
{
"id" : "MedicationDispense.location",
"path" : "MedicationDispense.location",
"short" : "Where the dispense occurred",
"definition" : "The principal physical location where the dispense was performed.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicationDispense.location",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Location"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".participation[typeCode=LOC].role"
}]
},
{
"id" : "MedicationDispense.authorizingPrescription",
"path" : "MedicationDispense.authorizingPrescription",
"short" : "Medication order that authorizes the dispense",
"definition" : "Indicates the medication order that is being dispensed against.",
"comment" : "Maps to basedOn in Event logical model.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicationDispense.authorizingPrescription",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/MedicationRequest"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.basedOn"
},
{
"identity" : "v2",
"map" : "ORC-2 Placer Order Number"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=FLFS].target[moodCode=RQO]"
},
{
"identity" : "rx-dispense-rmim",
"map" : "CombinedMedicationDispense.inFulfillmentOf"
}]
},
{
"id" : "MedicationDispense.type",
"path" : "MedicationDispense.type",
"short" : "Trial fill, partial fill, emergency fill, etc.",
"definition" : "Indicates the type of dispensing event that is performed. For example, Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicationDispense.type",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MedicationDispenseType"
}],
"strength" : "example",
"description" : "Indicates the type of dispensing event that is performed. For example, Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-ActPharmacySupplyType"
},
"mapping" : [{
"identity" : "v2",
"map" : "RXD-33-Dispense Type"
},
{
"identity" : "rim",
"map" : ".code"
},
{
"identity" : "rx-dispense-rmim",
"map" : "CombinedMedicationDispense.SupplyEvent.code"
}]
},
{
"id" : "MedicationDispense.quantity",
"path" : "MedicationDispense.quantity",
"short" : "Amount dispensed",
"definition" : "The amount of medication that has been dispensed. Includes unit of measure.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicationDispense.quantity",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Quantity",
"profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "RXD-4-Actual Dispense Amount / RXD-5.1-Actual Dispense Units.code / RXD-5.3-Actual Dispense Units.name of coding system"
},
{
"identity" : "rim",
"map" : ".quantity"
},
{
"identity" : "rx-dispense-rmim",
"map" : "CombinedMedicationDispense.SupplyEvent.quantity"
}]
},
{
"id" : "MedicationDispense.daysSupply",
"path" : "MedicationDispense.daysSupply",
"short" : "Amount of medication expressed as a timing amount",
"definition" : "The amount of medication expressed as a timing amount.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicationDispense.daysSupply",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Quantity",
"profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "TQ1.6 Timing/Quantity Segment Service Duration.\rPrior to v2.5, ORC.7.3 Common Order Segment / Quantity/Timing / Duration component. This is a formatted string, first character for the time unit (e.g., D=days), followed by the value. For example, “D14” represents “14 days supply”\rFrom v2.5 on, TQ1.6 Timing/Quantity Segment / Service Duration. This is a CQ data type ( ^ ), thus for days supply, assuming the unit of measure is “days”, the numeric value is TQ1.6.1 (…|14^\rFor backwards compatibility, ORC.7 was permitted through v2.6. Both forms (field and segment) may be present in v2.5, v2.5.1, and v2.6"
},
{
"identity" : "rim",
"map" : "effectiveUseTime"
}]
},
{
"id" : "MedicationDispense.whenPrepared",
"path" : "MedicationDispense.whenPrepared",
"short" : "When product was packaged and reviewed",
"definition" : "The time when the dispensed product was packaged and reviewed.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicationDispense.whenPrepared",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "v2",
"map" : "RXD-3-Date/Time Dispensed"
},
{
"identity" : "rim",
"map" : ".effectiveTime[xmi:type=IVL_TS].low"
},
{
"identity" : "rx-dispense-rmim",
"map" : "CombinedMedicationDispense.SupplyEvent.effectiveTime"
}]
},
{
"id" : "MedicationDispense.whenHandedOver",
"path" : "MedicationDispense.whenHandedOver",
"short" : "When product was given out",
"definition" : "The time the dispensed product was provided to the patient or their representative.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicationDispense.whenHandedOver",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.occurrence[x]"
},
{
"identity" : "v2",
"map" : "RXD-3-Date/Time Dispensed"
},
{
"identity" : "rim",
"map" : ".effectiveTime[xmi:type=IVL_TS].high"
},
{
"identity" : "rx-dispense-rmim",
"map" : "CombinedMedicationDispense.SupplyEvent.effectiveTime"
}]
},
{
"id" : "MedicationDispense.destination",
"path" : "MedicationDispense.destination",
"short" : "Where the medication was sent",
"definition" : "Identification of the facility/location where the medication was shipped to, as part of the dispense event.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicationDispense.destination",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Location"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "RXD-13 Dispense-to Location; RXD-30 Dispense to Pharmacy; RXD-31 Dispense to Pharmacy Address"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=DST].role"
},
{
"identity" : "rx-dispense-rmim",
"map" : "CombinedMedicationDispense.SupplyEvent.destination"
}]
},
{
"id" : "MedicationDispense.receiver",
"path" : "MedicationDispense.receiver",
"short" : "Who collected the medication",
"definition" : "Identifies the person who picked up the medication. This will usually be a patient or their caregiver, but some cases exist where it can be a healthcare professional.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicationDispense.receiver",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Practitioner"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".participation[typeCode=RCV].role"
},
{
"identity" : "rx-dispense-rmim",
"map" : "CombinedMedicationDispense.SupplyEvent.receiver"
}]
},
{
"id" : "MedicationDispense.note",
"path" : "MedicationDispense.note",
"short" : "Information about the dispense",
"definition" : "Extra information about the dispense that could not be conveyed in the other attributes.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicationDispense.note",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Annotation"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.note"
},
{
"identity" : "v2",
"map" : "RXD-9 Dispense Notes"
},
{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=SUBJ]/source[classCode=ACT,moodCode=EVN]"
}]
},
{
"id" : "MedicationDispense.dosageInstruction",
"path" : "MedicationDispense.dosageInstruction",
"short" : "How the medication is to be used by the patient or administered by the caregiver",
"definition" : "Indicates how the medication is to be used by the patient.",
"comment" : "When the dose or rate is intended to change over the entire administration period (e.g. Tapering dose prescriptions), multiple instances of dosage instructions will need to be supplied to convey the different doses/rates.\rThe pharmacist reviews the medication order prior to dispense and updates the dosageInstruction based on the actual product being dispensed.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicationDispense.dosageInstruction",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Dosage"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=COMP].target[classCode=SBADM, moodCode=INT]"
}]
},
{
"id" : "MedicationDispense.substitution",
"path" : "MedicationDispense.substitution",
"short" : "Whether a substitution was performed on the dispense",
"definition" : "Indicates whether or not substitution was made as part of the dispense. In some cases, substitution will be expected but does not happen, in other cases substitution is not expected but does happen. This block explains what substitution did or did not happen and why. If nothing is specified, substitution was not done.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicationDispense.substitution",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=COMP].target[classCode=SUBST, moodCode=EVN]"
},
{
"identity" : "rx-dispense-rmim",
"map" : "CombinedMedicationDispense.substitutionMade"
}]
},
{
"id" : "MedicationDispense.substitution.id",
"path" : "MedicationDispense.substitution.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MedicationDispense.substitution.extension",
"path" : "MedicationDispense.substitution.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MedicationDispense.substitution.modifierExtension",
"path" : "MedicationDispense.substitution.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MedicationDispense.substitution.wasSubstituted",
"path" : "MedicationDispense.substitution.wasSubstituted",
"short" : "Whether a substitution was or was not performed on the dispense",
"definition" : "True if the dispenser dispensed a different drug or product from what was prescribed.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "MedicationDispense.substitution.wasSubstituted",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".actionNegationInd"
}]
},
{
"id" : "MedicationDispense.substitution.type",
"path" : "MedicationDispense.substitution.type",
"short" : "Code signifying whether a different drug was dispensed from what was prescribed",
"definition" : "A code signifying whether a different drug was dispensed from what was prescribed.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicationDispense.substitution.type",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MedicationIntendedSubstitutionType"
}],
"strength" : "example",
"description" : "A coded concept describing whether a different medicinal product may be dispensed other than the product as specified exactly in the prescription.",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-ActSubstanceAdminSubstitutionCode"
},
"mapping" : [{
"identity" : "v2",
"map" : "RXO-9-Allow Substitutions / RXE-9-Substitution Status"
},
{
"identity" : "rim",
"map" : ".code"
},
{
"identity" : "rx-dispense-rmim",
"map" : "CombinedMedicationDispense.substitutionMade.code"
}]
},
{
"id" : "MedicationDispense.substitution.reason",
"path" : "MedicationDispense.substitution.reason",
"short" : "Why was substitution made",
"definition" : "Indicates the reason for the substitution (or lack of substitution) from what was prescribed.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicationDispense.substitution.reason",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MedicationIntendedSubstitutionReason"
}],
"strength" : "example",
"description" : "A coded concept describing the reason that a different medication should (or should not) be substituted from what was prescribed.",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-SubstanceAdminSubstitutionReason"
},
"mapping" : [{
"identity" : "rim",
"map" : ".reasonCode"
},
{
"identity" : "rx-dispense-rmim",
"map" : "CombinedMedicationDispense.substitutionMade.reasonCode"
}]
},
{
"id" : "MedicationDispense.substitution.responsibleParty",
"path" : "MedicationDispense.substitution.responsibleParty",
"short" : "Who is responsible for the substitution",
"definition" : "The person or organization that has primary responsibility for the substitution.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicationDispense.substitution.responsibleParty",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".participation[typeCode=PFM].role[classCode=ASSIGN]"
},
{
"identity" : "rx-dispense-rmim",
"map" : "CombinedMedicationDispense.substitutionMade.ResponsibleParty"
}]
},
{
"id" : "MedicationDispense.detectedIssue",
"path" : "MedicationDispense.detectedIssue",
"short" : "Clinical issue with action",
"definition" : "Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. drug-drug interaction, duplicate therapy, dosage alert etc.",
"comment" : "This element can include a detected issue that has been identified either by a decision support system or by a clinician and may include information on the steps that were taken to address the issue.",
"alias" : ["Contraindication",
"Drug Utilization Review (DUR)",
"Alert"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicationDispense.detectedIssue",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/DetectedIssue"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=SUBJ]/source[classCode=ALRT,moodCode=EVN].value"
}]
},
{
"id" : "MedicationDispense.eventHistory",
"path" : "MedicationDispense.eventHistory",
"short" : "A list of relevant lifecycle events",
"definition" : "A summary of the events of interest that have occurred, such as when the dispense was verified.",
"comment" : "This might not include provenances for all versions of the request – only those deemed “relevant” or important. This SHALL NOT include the Provenance associated with this current version of the resource. (If that provenance is deemed to be a “relevant” change, it will need to be added as part of a later update. Until then, it can be queried directly as the Provenance that points to this version using _revinclude All Provenances should have some historical version of this Request as their subject.).",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicationDispense.eventHistory",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Provenance"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".inboundRelationship(typeCode=SUBJ].source[classCode=CACT, moodCode=EVN]"
}]
}]
},
"differential" : {
"element" : [{
"id" : "MedicationDispense",
"path" : "MedicationDispense",
"short" : "Dispensing a medication to a named patient",
"definition" : "Indicates that a medication product is to be or has been dispensed for a named person/patient. This includes a description of the medication product (supply) provided and the instructions for administering the medication. The medication dispense is the result of a pharmacy system responding to a medication order.",
"min" : 0,
"max" : "*",
"constraint" : [{
"key" : "mdd-1",
"severity" : "error",
"human" : "whenHandedOver cannot be before whenPrepared",
"expression" : "whenHandedOver.empty() or whenPrepared.empty() or whenHandedOver >= whenPrepared",
"xpath" : "not(exists(f:whenHandedOver/@value)) or not(exists(f:whenPrepared/@value)) or ( f:whenHandedOver/@value >= f:whenPrepared/@value)"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Event"
},
{
"identity" : "rim",
"map" : "Supply[moodCode=EVN]"
}]
},
{
"id" : "MedicationDispense.identifier",
"path" : "MedicationDispense.identifier",
"short" : "External identifier",
"definition" : "Identifiers associated with this Medication Dispense that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server.",
"comment" : "This is a business identifier, not a resource identifier.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Identifier"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Event.identifier"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "rim",
"map" : ".id"
},
{
"identity" : "rx-dispense-rmim",
"map" : "CombinedMedicationDispense.id"
}]
},
{
"id" : "MedicationDispense.partOf",
"path" : "MedicationDispense.partOf",
"short" : "Event that dispense is part of",
"definition" : "The procedure that trigger the dispense.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Procedure"]
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Event.partOf"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=COMP]/target[classCode=PROC,moodCode=EVN]"
}]
},
{
"id" : "MedicationDispense.status",
"path" : "MedicationDispense.status",
"short" : "preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown",
"definition" : "A code specifying the state of the set of dispense events.",
"comment" : "This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isModifier" : true,
"isModifierReason" : "This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MedicationDispenseStatus"
}],
"strength" : "required",
"description" : "A coded concept specifying the state of the dispense event.",
"valueSet" : "http://hl7.org/fhir/ValueSet/medicationdispense-status|4.0.1"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.status"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
},
{
"identity" : "rim",
"map" : ".statusCode"
},
{
"identity" : "rx-dispense-rmim",
"map" : "CombinedMedicationDispense.SupplyEvent.statusCode"
}]
},
{
"id" : "MedicationDispense.statusReason[x]",
"path" : "MedicationDispense.statusReason[x]",
"short" : "Why a dispense was not performed",
"definition" : "Indicates the reason why a dispense was not performed.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
},
{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/DetectedIssue"]
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MedicationDispenseStatusReason"
}],
"strength" : "example",
"description" : "A code describing why a dispense was not performed.",
"valueSet" : "http://hl7.org/fhir/ValueSet/medicationdispense-status-reason"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.statusReason"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=RSON]/target[classCode=OBS,moodCode=EVN, code=\"not done reason\"].value"
}]
},
{
"id" : "MedicationDispense.category",
"path" : "MedicationDispense.category",
"short" : "Type of medication dispense",
"definition" : "Indicates the type of medication dispense (for example, where the medication is expected to be consumed or administered (i.e. inpatient or outpatient)).",
"comment" : "The category can be used to include where the medication is expected to be consumed or other types of dispenses. Invariants can be used to bind to different value sets when profiling to bind.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MedicationDispenseCategory"
}],
"strength" : "preferred",
"description" : "A code describing where the dispensed medication is expected to be consumed or administered.",
"valueSet" : "http://hl7.org/fhir/ValueSet/medicationdispense-category"
},
"mapping" : [{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=COMP].source[classCode=OBS, moodCode=EVN, code=\"type of medication dispense\"].value"
}]
},
{
"id" : "MedicationDispense.medication[x]",
"path" : "MedicationDispense.medication[x]",
"short" : "What medication was supplied",
"definition" : "Identifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.",
"comment" : "If only a code is specified, then it needs to be a code for a specific product. If more information is required, then the use of the medication resource is recommended. For example, if you require form or lot number, then you must reference the Medication resource.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
},
{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Medication"]
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MedicationCode"
}],
"strength" : "example",
"description" : "A coded concept identifying which substance or product can be dispensed.",
"valueSet" : "http://hl7.org/fhir/ValueSet/medication-codes"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.code"
},
{
"identity" : "w5",
"map" : "FiveWs.what[x]"
},
{
"identity" : "v2",
"map" : "RXD-2-Dispense/Give Code"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=PRD].role"
},
{
"identity" : "rx-dispense-rmim",
"map" : "CombinedMedicationRequest.component1.AdministrationRequest.consumable"
}]
},
{
"id" : "MedicationDispense.subject",
"path" : "MedicationDispense.subject",
"short" : "Who the dispense is for",
"definition" : "A link to a resource representing the person or the group to whom the medication will be given.",
"comment" : "SubstanceAdministration->subject->Patient.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Group"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.subject"
},
{
"identity" : "w5",
"map" : "FiveWs.subject[x]"
},
{
"identity" : "v2",
"map" : "PID-3-Patient ID List"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=SBJ].role[classCode=PAT]"
},
{
"identity" : "w5",
"map" : "FiveWs.subject"
}]
},
{
"id" : "MedicationDispense.context",
"path" : "MedicationDispense.context",
"short" : "Encounter / Episode associated with event",
"definition" : "The encounter or episode of care that establishes the context for this event.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Encounter",
"http://hl7.org/fhir/StructureDefinition/EpisodeOfCare"]
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Event.context"
},
{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN, code=\"type of encounter or episode\"]"
}]
},
{
"id" : "MedicationDispense.supportingInformation",
"path" : "MedicationDispense.supportingInformation",
"short" : "Information that supports the dispensing of the medication",
"definition" : "Additional information that supports the medication being dispensed.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.context"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=PERT].target[A_SupportingClinicalStatement CMET minimal with many different choices of classCodes(ORG, ENC, PROC, SPLY, SBADM, OBS) and each of the act class codes draws from one or more of the following moodCodes (EVN, DEF, INT PRMS, RQO, PRP, APT, ARQ, GOL)]"
}]
},
{
"id" : "MedicationDispense.performer",
"path" : "MedicationDispense.performer",
"short" : "Who performed event",
"definition" : "Indicates who or what performed the event.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Event.performer"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=PRF]"
}]
},
{
"id" : "MedicationDispense.performer.function",
"path" : "MedicationDispense.performer.function",
"short" : "Who performed the dispense and what they did",
"definition" : "Distinguishes the type of performer in the dispense. For example, date enterer, packager, final checker.",
"requirements" : "Allows disambiguation of the types of involvement of different performers.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MedicationDispensePerformerFunction"
}],
"strength" : "example",
"description" : "A code describing the role an individual played in dispensing a medication.",
"valueSet" : "http://hl7.org/fhir/ValueSet/medicationdispense-performer-function"
},
"mapping" : [{
"identity" : "rim",
"map" : "participation[typeCode=PRF].functionCode"
}]
},
{
"id" : "MedicationDispense.performer.actor",
"path" : "MedicationDispense.performer.actor",
"short" : "Individual who was performing",
"definition" : "The device, practitioner, etc. who performed the action. It should be assumed that the actor is the dispenser of the medication.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Organization",
"http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Device",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson"]
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Event.performer.actor"
},
{
"identity" : "rim",
"map" : ".role"
}]
},
{
"id" : "MedicationDispense.location",
"path" : "MedicationDispense.location",
"short" : "Where the dispense occurred",
"definition" : "The principal physical location where the dispense was performed.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Location"]
}],
"mapping" : [{
"identity" : "rim",
"map" : ".participation[typeCode=LOC].role"
}]
},
{
"id" : "MedicationDispense.authorizingPrescription",
"path" : "MedicationDispense.authorizingPrescription",
"short" : "Medication order that authorizes the dispense",
"definition" : "Indicates the medication order that is being dispensed against.",
"comment" : "Maps to basedOn in Event logical model.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/MedicationRequest"]
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Event.basedOn"
},
{
"identity" : "v2",
"map" : "ORC-2 Placer Order Number"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=FLFS].target[moodCode=RQO]"
},
{
"identity" : "rx-dispense-rmim",
"map" : "CombinedMedicationDispense.inFulfillmentOf"
}]
},
{
"id" : "MedicationDispense.type",
"path" : "MedicationDispense.type",
"short" : "Trial fill, partial fill, emergency fill, etc.",
"definition" : "Indicates the type of dispensing event that is performed. For example, Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MedicationDispenseType"
}],
"strength" : "example",
"description" : "Indicates the type of dispensing event that is performed. For example, Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-ActPharmacySupplyType"
},
"mapping" : [{
"identity" : "v2",
"map" : "RXD-33-Dispense Type"
},
{
"identity" : "rim",
"map" : ".code"
},
{
"identity" : "rx-dispense-rmim",
"map" : "CombinedMedicationDispense.SupplyEvent.code"
}]
},
{
"id" : "MedicationDispense.quantity",
"path" : "MedicationDispense.quantity",
"short" : "Amount dispensed",
"definition" : "The amount of medication that has been dispensed. Includes unit of measure.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Quantity",
"profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
}],
"mapping" : [{
"identity" : "v2",
"map" : "RXD-4-Actual Dispense Amount / RXD-5.1-Actual Dispense Units.code / RXD-5.3-Actual Dispense Units.name of coding system"
},
{
"identity" : "rim",
"map" : ".quantity"
},
{
"identity" : "rx-dispense-rmim",
"map" : "CombinedMedicationDispense.SupplyEvent.quantity"
}]
},
{
"id" : "MedicationDispense.daysSupply",
"path" : "MedicationDispense.daysSupply",
"short" : "Amount of medication expressed as a timing amount",
"definition" : "The amount of medication expressed as a timing amount.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Quantity",
"profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
}],
"mapping" : [{
"identity" : "v2",
"map" : "TQ1.6 Timing/Quantity Segment Service Duration.\rPrior to v2.5, ORC.7.3 Common Order Segment / Quantity/Timing / Duration component. This is a formatted string, first character for the time unit (e.g., D=days), followed by the value. For example, “D14” represents “14 days supply”\rFrom v2.5 on, TQ1.6 Timing/Quantity Segment / Service Duration. This is a CQ data type ( ^ ), thus for days supply, assuming the unit of measure is “days”, the numeric value is TQ1.6.1 (…|14^\rFor backwards compatibility, ORC.7 was permitted through v2.6. Both forms (field and segment) may be present in v2.5, v2.5.1, and v2.6"
},
{
"identity" : "rim",
"map" : "effectiveUseTime"
}]
},
{
"id" : "MedicationDispense.whenPrepared",
"path" : "MedicationDispense.whenPrepared",
"short" : "When product was packaged and reviewed",
"definition" : "The time when the dispensed product was packaged and reviewed.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "dateTime"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "v2",
"map" : "RXD-3-Date/Time Dispensed"
},
{
"identity" : "rim",
"map" : ".effectiveTime[xmi:type=IVL_TS].low"
},
{
"identity" : "rx-dispense-rmim",
"map" : "CombinedMedicationDispense.SupplyEvent.effectiveTime"
}]
},
{
"id" : "MedicationDispense.whenHandedOver",
"path" : "MedicationDispense.whenHandedOver",
"short" : "When product was given out",
"definition" : "The time the dispensed product was provided to the patient or their representative.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "dateTime"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Event.occurrence[x]"
},
{
"identity" : "v2",
"map" : "RXD-3-Date/Time Dispensed"
},
{
"identity" : "rim",
"map" : ".effectiveTime[xmi:type=IVL_TS].high"
},
{
"identity" : "rx-dispense-rmim",
"map" : "CombinedMedicationDispense.SupplyEvent.effectiveTime"
}]
},
{
"id" : "MedicationDispense.destination",
"path" : "MedicationDispense.destination",
"short" : "Where the medication was sent",
"definition" : "Identification of the facility/location where the medication was shipped to, as part of the dispense event.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Location"]
}],
"mapping" : [{
"identity" : "v2",
"map" : "RXD-13 Dispense-to Location; RXD-30 Dispense to Pharmacy; RXD-31 Dispense to Pharmacy Address"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=DST].role"
},
{
"identity" : "rx-dispense-rmim",
"map" : "CombinedMedicationDispense.SupplyEvent.destination"
}]
},
{
"id" : "MedicationDispense.receiver",
"path" : "MedicationDispense.receiver",
"short" : "Who collected the medication",
"definition" : "Identifies the person who picked up the medication. This will usually be a patient or their caregiver, but some cases exist where it can be a healthcare professional.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Practitioner"]
}],
"mapping" : [{
"identity" : "rim",
"map" : ".participation[typeCode=RCV].role"
},
{
"identity" : "rx-dispense-rmim",
"map" : "CombinedMedicationDispense.SupplyEvent.receiver"
}]
},
{
"id" : "MedicationDispense.note",
"path" : "MedicationDispense.note",
"short" : "Information about the dispense",
"definition" : "Extra information about the dispense that could not be conveyed in the other attributes.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Annotation"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Event.note"
},
{
"identity" : "v2",
"map" : "RXD-9 Dispense Notes"
},
{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=SUBJ]/source[classCode=ACT,moodCode=EVN]"
}]
},
{
"id" : "MedicationDispense.dosageInstruction",
"path" : "MedicationDispense.dosageInstruction",
"short" : "How the medication is to be used by the patient or administered by the caregiver",
"definition" : "Indicates how the medication is to be used by the patient.",
"comment" : "When the dose or rate is intended to change over the entire administration period (e.g. Tapering dose prescriptions), multiple instances of dosage instructions will need to be supplied to convey the different doses/rates.\rThe pharmacist reviews the medication order prior to dispense and updates the dosageInstruction based on the actual product being dispensed.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Dosage"
}],
"mapping" : [{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=COMP].target[classCode=SBADM, moodCode=INT]"
}]
},
{
"id" : "MedicationDispense.substitution",
"path" : "MedicationDispense.substitution",
"short" : "Whether a substitution was performed on the dispense",
"definition" : "Indicates whether or not substitution was made as part of the dispense. In some cases, substitution will be expected but does not happen, in other cases substitution is not expected but does happen. This block explains what substitution did or did not happen and why. If nothing is specified, substitution was not done.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "BackboneElement"
}],
"mapping" : [{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=COMP].target[classCode=SUBST, moodCode=EVN]"
},
{
"identity" : "rx-dispense-rmim",
"map" : "CombinedMedicationDispense.substitutionMade"
}]
},
{
"id" : "MedicationDispense.substitution.wasSubstituted",
"path" : "MedicationDispense.substitution.wasSubstituted",
"short" : "Whether a substitution was or was not performed on the dispense",
"definition" : "True if the dispenser dispensed a different drug or product from what was prescribed.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "boolean"
}],
"mapping" : [{
"identity" : "rim",
"map" : ".actionNegationInd"
}]
},
{
"id" : "MedicationDispense.substitution.type",
"path" : "MedicationDispense.substitution.type",
"short" : "Code signifying whether a different drug was dispensed from what was prescribed",
"definition" : "A code signifying whether a different drug was dispensed from what was prescribed.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MedicationIntendedSubstitutionType"
}],
"strength" : "example",
"description" : "A coded concept describing whether a different medicinal product may be dispensed other than the product as specified exactly in the prescription.",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-ActSubstanceAdminSubstitutionCode"
},
"mapping" : [{
"identity" : "v2",
"map" : "RXO-9-Allow Substitutions / RXE-9-Substitution Status"
},
{
"identity" : "rim",
"map" : ".code"
},
{
"identity" : "rx-dispense-rmim",
"map" : "CombinedMedicationDispense.substitutionMade.code"
}]
},
{
"id" : "MedicationDispense.substitution.reason",
"path" : "MedicationDispense.substitution.reason",
"short" : "Why was substitution made",
"definition" : "Indicates the reason for the substitution (or lack of substitution) from what was prescribed.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MedicationIntendedSubstitutionReason"
}],
"strength" : "example",
"description" : "A coded concept describing the reason that a different medication should (or should not) be substituted from what was prescribed.",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-SubstanceAdminSubstitutionReason"
},
"mapping" : [{
"identity" : "rim",
"map" : ".reasonCode"
},
{
"identity" : "rx-dispense-rmim",
"map" : "CombinedMedicationDispense.substitutionMade.reasonCode"
}]
},
{
"id" : "MedicationDispense.substitution.responsibleParty",
"path" : "MedicationDispense.substitution.responsibleParty",
"short" : "Who is responsible for the substitution",
"definition" : "The person or organization that has primary responsibility for the substitution.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole"]
}],
"mapping" : [{
"identity" : "rim",
"map" : ".participation[typeCode=PFM].role[classCode=ASSIGN]"
},
{
"identity" : "rx-dispense-rmim",
"map" : "CombinedMedicationDispense.substitutionMade.ResponsibleParty"
}]
},
{
"id" : "MedicationDispense.detectedIssue",
"path" : "MedicationDispense.detectedIssue",
"short" : "Clinical issue with action",
"definition" : "Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. drug-drug interaction, duplicate therapy, dosage alert etc.",
"comment" : "This element can include a detected issue that has been identified either by a decision support system or by a clinician and may include information on the steps that were taken to address the issue.",
"alias" : ["Contraindication",
"Drug Utilization Review (DUR)",
"Alert"],
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/DetectedIssue"]
}],
"mapping" : [{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=SUBJ]/source[classCode=ALRT,moodCode=EVN].value"
}]
},
{
"id" : "MedicationDispense.eventHistory",
"path" : "MedicationDispense.eventHistory",
"short" : "A list of relevant lifecycle events",
"definition" : "A summary of the events of interest that have occurred, such as when the dispense was verified.",
"comment" : "This might not include provenances for all versions of the request – only those deemed “relevant” or important. This SHALL NOT include the Provenance associated with this current version of the resource. (If that provenance is deemed to be a “relevant” change, it will need to be added as part of a later update. Until then, it can be queried directly as the Provenance that points to this version using _revinclude All Provenances should have some historical version of this Request as their subject.).",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Provenance"]
}],
"mapping" : [{
"identity" : "rim",
"map" : ".inboundRelationship(typeCode=SUBJ].source[classCode=CACT, moodCode=EVN]"
}]
}]
}
}
},
{
"fullUrl" : "http://hl7.org/fhir/StructureDefinition/MedicationKnowledge",
"resource" : {
"resourceType" : "StructureDefinition",
"id" : "MedicationKnowledge",
"meta" : {
"lastUpdated" : "2019-11-01T09:29:23.356+11:00"
},
"text" : {
"status" : "generated",
"div" : "Name Flags Card. Type Description & Constraints MedicationKnowledge TU DomainResource Definition of Medication Knowledge
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension code Σ 0..1 CodeableConcept Code that identifies this medication
SNOMED CT Medication Codes (Example) status ?!Σ 0..1 code active | inactive | entered-in-error
Medication knowledge status codes (Required) manufacturer Σ 0..1 Reference(Organization) Manufacturer of the item doseForm 0..1 CodeableConcept powder | tablets | capsule +
SNOMED CT Form Codes (Example) amount Σ 0..1 SimpleQuantity Amount of drug in package synonym Σ 0..* string Additional names for a medication
relatedMedicationKnowledge 0..* BackboneElement Associated or related medication information
type 1..1 CodeableConcept Category of medicationKnowledge reference 1..* Reference(MedicationKnowledge) Associated documentation about the associated medication knowledge
associatedMedication 0..* Reference(Medication) A medication resource that is associated with this medication
productType 0..* CodeableConcept Category of the medication or product
monograph 0..* BackboneElement Associated documentation about the medication
type 0..1 CodeableConcept The category of medication document source 0..1 Reference(DocumentReference | Media) Associated documentation about the medication ingredient 0..* BackboneElement Active or inactive ingredient
item[x] 1..1 Medication(s) or substance(s) contained in the medication itemCodeableConcept CodeableConcept itemReference Reference(Substance) isActive 0..1 boolean Active ingredient indicator strength 0..1 Ratio Quantity of ingredient present preparationInstruction 0..1 markdown The instructions for preparing the medication intendedRoute 0..* CodeableConcept The intended or approved route of administration
SNOMED CT Route Codes (Example)
cost 0..* BackboneElement The pricing of the medication
type 1..1 CodeableConcept The category of the cost information source 0..1 string The source or owner for the price information cost 1..1 Money The price of the medication monitoringProgram 0..* BackboneElement Program under which a medication is reviewed
type 0..1 CodeableConcept Type of program under which the medication is monitored name 0..1 string Name of the reviewing program administrationGuidelines 0..* BackboneElement Guidelines for administration of the medication
dosage 0..* BackboneElement Dosage for the medication for the specific guidelines
type 1..1 CodeableConcept Type of dosage dosage 1..* Dosage Dosage for the medication for the specific guidelines
indication[x] 0..1 Indication for use that apply to the specific administration guidelines indicationCodeableConcept CodeableConcept indicationReference Reference(ObservationDefinition) patientCharacteristics 0..* BackboneElement Characteristics of the patient that are relevant to the administration guidelines
characteristic[x] 1..1 Specific characteristic that is relevant to the administration guideline characteristicCodeableConcept CodeableConcept characteristicQuantity SimpleQuantity value 0..* string The specific characteristic
medicineClassification 0..* BackboneElement Categorization of the medication within a formulary or classification system
type 1..1 CodeableConcept The type of category for the medication (for example, therapeutic classification, therapeutic sub-classification) classification 0..* CodeableConcept Specific category assigned to the medication
packaging 0..1 BackboneElement Details about packaged medications type 0..1 CodeableConcept A code that defines the specific type of packaging that the medication can be found in
Medication knowledge package type codes (Example) quantity 0..1 SimpleQuantity The number of product units the package would contain if fully loaded drugCharacteristic 0..* BackboneElement Specifies descriptive properties of the medicine
type 0..1 CodeableConcept Code specifying the type of characteristic of medication
Medication knowledge characteristic codes (Example) value[x] 0..1 Description of the characteristic valueCodeableConcept CodeableConcept valueString string valueQuantity SimpleQuantity valueBase64Binary base64Binary contraindication 0..* Reference(DetectedIssue) Potential clinical issue with or between medication(s)
regulatory 0..* BackboneElement Regulatory information about a medication
regulatoryAuthority 1..1 Reference(Organization) Specifies the authority of the regulation substitution 0..* BackboneElement Specifies if changes are allowed when dispensing a medication from a regulatory perspective
type 1..1 CodeableConcept Specifies the type of substitution allowed allowed 1..1 boolean Specifies if regulation allows for changes in the medication when dispensing schedule 0..* BackboneElement Specifies the schedule of a medication in jurisdiction
schedule 1..1 CodeableConcept Specifies the specific drug schedule maxDispense 0..1 BackboneElement The maximum number of units of the medication that can be dispensed in a period quantity 1..1 SimpleQuantity The maximum number of units of the medication that can be dispensed period 0..1 Duration The period that applies to the maximum number of units kinetics 0..* BackboneElement The time course of drug absorption, distribution, metabolism and excretion of a medication from the body
areaUnderCurve 0..* SimpleQuantity The drug concentration measured at certain discrete points in time
lethalDose50 0..* SimpleQuantity The median lethal dose of a drug
halfLifePeriod 0..1 Duration Time required for concentration in the body to decrease by half
Documentation for this format
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Clinical.Medications"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 0
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "business"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "phx"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/MedicationKnowledge",
"version" : "4.0.1",
"name" : "MedicationKnowledge",
"status" : "draft",
"date" : "2019-11-01T09:29:23+11:00",
"publisher" : "Health Level Seven International (Pharmacy)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/medication/index.cfm"
}]
}],
"description" : "Information about a medication that is used to support knowledge.",
"fhirVersion" : "4.0.1",
"mapping" : [{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
},
{
"identity" : "script10.6",
"uri" : "http://ncpdp.org/SCRIPT10_6",
"name" : "Mapping to NCPDP SCRIPT 10.6"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/fivews",
"name" : "FiveWs Pattern Mapping"
},
{
"identity" : "v2",
"uri" : "http://hl7.org/v2",
"name" : "HL7 v2 Mapping"
}],
"kind" : "resource",
"abstract" : false,
"type" : "MedicationKnowledge",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "MedicationKnowledge",
"path" : "MedicationKnowledge",
"short" : "Definition of Medication Knowledge",
"definition" : "Information about a medication that is used to support knowledge.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicationKnowledge",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "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",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.`div`.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "rim",
"map" : "Todo"
}]
},
{
"id" : "MedicationKnowledge.id",
"path" : "MedicationKnowledge.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicationKnowledge.meta",
"path" : "MedicationKnowledge.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicationKnowledge.implicitRules",
"path" : "MedicationKnowledge.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "MedicationKnowledge.language",
"path" : "MedicationKnowledge.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "MedicationKnowledge.text",
"path" : "MedicationKnowledge.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "MedicationKnowledge.contained",
"path" : "MedicationKnowledge.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MedicationKnowledge.extension",
"path" : "MedicationKnowledge.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MedicationKnowledge.modifierExtension",
"path" : "MedicationKnowledge.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MedicationKnowledge.code",
"path" : "MedicationKnowledge.code",
"short" : "Code that identifies this medication",
"definition" : "A code that specifies this medication, or a textual description if no code is available. Usage note: This could be a standard medication code such as a code from RxNorm, SNOMED CT, IDMP etc. It could also be a national or local formulary code, optionally with translations to other code systems.",
"comment" : "Depending on the context of use, the code that was actually selected by the user (prescriber, dispenser, etc.) will have the coding.userSelected set to true. As described in the coding datatype: \"A coding may be marked as a \"userSelected\" if a user selected the particular coded value in a user interface (e.g. the user selects an item in a pick-list). If a user selected coding exists, it is the preferred choice for performing translations etc. Other codes can only be literal translations to alternative code systems, or codes at a lower level of granularity (e.g. a generic code for a vendor-specific primary one).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicationKnowledge.code",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MedicationFormalRepresentation"
}],
"strength" : "example",
"description" : "A coded concept that defines the type of a medication.",
"valueSet" : "http://hl7.org/fhir/ValueSet/medication-codes"
},
"mapping" : [{
"identity" : "script10.6",
"map" : "coding.code = //element(*,MedicationType)/DrugCoded/ProductCode\r\rcoding.system = //element(*,MedicationType)/DrugCoded/ProductCodeQualifier\r\rcoding.display = //element(*,MedicationType)/DrugDescription"
},
{
"identity" : "w5",
"map" : "FiveWs.class"
},
{
"identity" : "v2",
"map" : "RXO-1.1-Requested Give Code.code / RXE-2.1-Give Code.code / RXD-2.1-Dispense/Give Code.code / RXG-4.1-Give Code.code /RXA-5.1-Administered Code.code / RXC-2.1 Component Code"
},
{
"identity" : "rim",
"map" : ".code"
}]
},
{
"id" : "MedicationKnowledge.status",
"path" : "MedicationKnowledge.status",
"short" : "active | inactive | entered-in-error",
"definition" : "A code to indicate if the medication is in active use. The status refers to the validity about the information of the medication and not to its medicinal properties.",
"comment" : "This status is intended to identify if the medication in a local system is in active use within a drug database or inventory. For example, a pharmacy system may create a new drug file record for a compounded product \"ABC Hospital Special Cream\" with an active status. At some point in the future, it may be determined that the drug record was created with an error and the status is changed to \"entered in error\". This status is not intended to specify if a medication is part of a particular formulary. It is possible that the drug record may be referenced by multiple formularies or catalogues and each of those entries would have a separate status.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicationKnowledge.status",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element changes the interpretation of all descriptive attributes.",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MedicationKnowledgeStatus"
}],
"strength" : "required",
"description" : "A coded concept defining if the medication is in active use.",
"valueSet" : "http://hl7.org/fhir/ValueSet/medicationknowledge-status|4.0.1"
},
"mapping" : [{
"identity" : "rim",
"map" : ".statusCode"
}]
},
{
"id" : "MedicationKnowledge.manufacturer",
"path" : "MedicationKnowledge.manufacturer",
"short" : "Manufacturer of the item",
"definition" : "Describes the details of the manufacturer of the medication product. This is not intended to represent the distributor of a medication product.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicationKnowledge.manufacturer",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "script10.6",
"map" : "no mapping"
},
{
"identity" : "w5",
"map" : "FiveWs.actor"
},
{
"identity" : "v2",
"map" : "RXD-20-Substance Manufacturer Name / RXG-21-Substance Manufacturer Name / RXA-17-Substance Manufacturer Name"
},
{
"identity" : "rim",
"map" : ".player.scopingRole[typeCode=MANU].scoper"
}]
},
{
"id" : "MedicationKnowledge.doseForm",
"path" : "MedicationKnowledge.doseForm",
"short" : "powder | tablets | capsule +",
"definition" : "Describes the form of the item. Powder; tablets; capsule.",
"comment" : "When Medication is referenced from MedicationRequest, this is the ordered form. When Medication is referenced within MedicationDispense, this is the dispensed form. When Medication is referenced within MedicationAdministration, this is administered form.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicationKnowledge.doseForm",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MedicationForm"
}],
"strength" : "example",
"description" : "A coded concept defining the form of a medication.",
"valueSet" : "http://hl7.org/fhir/ValueSet/medication-form-codes"
},
"mapping" : [{
"identity" : "script10.6",
"map" : "coding.code = //element(*,DrugCodedType)/FormCode\r\rcoding.system = //element(*,DrugCodedType)/FormSourceCode"
},
{
"identity" : "v2",
"map" : "RXO-5-Requested Dosage Form / RXE-6-Give Dosage Form / RXD-6-Actual Dosage Form / RXG-8-Give Dosage Form / RXA-8-Administered Dosage Form"
},
{
"identity" : "rim",
"map" : ".formCode"
}]
},
{
"id" : "MedicationKnowledge.amount",
"path" : "MedicationKnowledge.amount",
"short" : "Amount of drug in package",
"definition" : "Specific amount of the drug in the packaged product. For example, when specifying a product that has the same strength (For example, Insulin glargine 100 unit per mL solution for injection), this attribute provides additional clarification of the package amount (For example, 3 mL, 10mL, etc.).",
"comment" : "This is the quantity of medication in a package. To specify the strength of the medication, the Ingredient.strength attribute is used.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicationKnowledge.amount",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Quantity",
"profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : ".quantity"
}]
},
{
"id" : "MedicationKnowledge.synonym",
"path" : "MedicationKnowledge.synonym",
"short" : "Additional names for a medication",
"definition" : "Additional names for a medication, for example, the name(s) given to a medication in different countries. For example, acetaminophen and paracetamol or salbutamol and albuterol.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicationKnowledge.synonym",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicationKnowledge.relatedMedicationKnowledge",
"path" : "MedicationKnowledge.relatedMedicationKnowledge",
"short" : "Associated or related medication information",
"definition" : "Associated or related knowledge about a medication.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicationKnowledge.relatedMedicationKnowledge",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "MedicationKnowledge.relatedMedicationKnowledge.id",
"path" : "MedicationKnowledge.relatedMedicationKnowledge.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MedicationKnowledge.relatedMedicationKnowledge.extension",
"path" : "MedicationKnowledge.relatedMedicationKnowledge.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MedicationKnowledge.relatedMedicationKnowledge.modifierExtension",
"path" : "MedicationKnowledge.relatedMedicationKnowledge.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MedicationKnowledge.relatedMedicationKnowledge.type",
"path" : "MedicationKnowledge.relatedMedicationKnowledge.type",
"short" : "Category of medicationKnowledge",
"definition" : "The category of the associated medication knowledge reference.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "MedicationKnowledge.relatedMedicationKnowledge.type",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "MedicationKnowledge.relatedMedicationKnowledge.reference",
"path" : "MedicationKnowledge.relatedMedicationKnowledge.reference",
"short" : "Associated documentation about the associated medication knowledge",
"definition" : "Associated documentation about the associated medication knowledge.",
"min" : 1,
"max" : "*",
"base" : {
"path" : "MedicationKnowledge.relatedMedicationKnowledge.reference",
"min" : 1,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/MedicationKnowledge"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "MedicationKnowledge.associatedMedication",
"path" : "MedicationKnowledge.associatedMedication",
"short" : "A medication resource that is associated with this medication",
"definition" : "Associated or related medications. For example, if the medication is a branded product (e.g. Crestor), this is the Therapeutic Moeity (e.g. Rosuvastatin) or if this is a generic medication (e.g. Rosuvastatin), this would link to a branded product (e.g. Crestor).",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicationKnowledge.associatedMedication",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Medication"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "MedicationKnowledge.productType",
"path" : "MedicationKnowledge.productType",
"short" : "Category of the medication or product",
"definition" : "Category of the medication or product (e.g. branded product, therapeutic moeity, generic product, innovator product, etc.).",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicationKnowledge.productType",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "MedicationKnowledge.monograph",
"path" : "MedicationKnowledge.monograph",
"short" : "Associated documentation about the medication",
"definition" : "Associated documentation about the medication.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicationKnowledge.monograph",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "MedicationKnowledge.monograph.id",
"path" : "MedicationKnowledge.monograph.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MedicationKnowledge.monograph.extension",
"path" : "MedicationKnowledge.monograph.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MedicationKnowledge.monograph.modifierExtension",
"path" : "MedicationKnowledge.monograph.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MedicationKnowledge.monograph.type",
"path" : "MedicationKnowledge.monograph.type",
"short" : "The category of medication document",
"definition" : "The category of documentation about the medication. (e.g. professional monograph, patient education monograph).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicationKnowledge.monograph.type",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "MedicationKnowledge.monograph.source",
"path" : "MedicationKnowledge.monograph.source",
"short" : "Associated documentation about the medication",
"definition" : "Associated documentation about the medication.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicationKnowledge.monograph.source",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/DocumentReference",
"http://hl7.org/fhir/StructureDefinition/Media"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "MedicationKnowledge.ingredient",
"path" : "MedicationKnowledge.ingredient",
"short" : "Active or inactive ingredient",
"definition" : "Identifies a particular constituent of interest in the product.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicationKnowledge.ingredient",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "MedicationKnowledge.ingredient.id",
"path" : "MedicationKnowledge.ingredient.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MedicationKnowledge.ingredient.extension",
"path" : "MedicationKnowledge.ingredient.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MedicationKnowledge.ingredient.modifierExtension",
"path" : "MedicationKnowledge.ingredient.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MedicationKnowledge.ingredient.item[x]",
"path" : "MedicationKnowledge.ingredient.item[x]",
"short" : "Medication(s) or substance(s) contained in the medication",
"definition" : "The actual ingredient - either a substance (simple ingredient) or another medication.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "MedicationKnowledge.ingredient.item[x]",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
},
{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Substance"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "script10.6",
"map" : "coding.code = //element(*,MedicationType)/DrugCoded/ProductCode\r\rcoding.system = //element(*,MedicationType)/DrugCoded/ProductCodeQualifier\r\rcoding.display = //element(*,MedicationType)/DrugDescription"
},
{
"identity" : "v2",
"map" : "RXC-2-Component Code if medication: RXO-1-Requested Give Code / RXE-2-Give Code / RXD-2-Dispense/Give Code / RXG-4-Give Code / RXA-5-Administered Code"
},
{
"identity" : "rim",
"map" : ".player"
}]
},
{
"id" : "MedicationKnowledge.ingredient.isActive",
"path" : "MedicationKnowledge.ingredient.isActive",
"short" : "Active ingredient indicator",
"definition" : "Indication of whether this ingredient affects the therapeutic action of the drug.",
"requirements" : "True indicates that the ingredient affects the therapeutic action of the drug (i.e. active). \rFalse indicates that the ingredient does not affect the therapeutic action of the drug (i.e. inactive).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicationKnowledge.ingredient.isActive",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "NA"
}]
},
{
"id" : "MedicationKnowledge.ingredient.strength",
"path" : "MedicationKnowledge.ingredient.strength",
"short" : "Quantity of ingredient present",
"definition" : "Specifies how many (or how much) of the items there are in this Medication. For example, 250 mg per tablet. This is expressed as a ratio where the numerator is 250mg and the denominator is 1 tablet.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicationKnowledge.ingredient.strength",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Ratio"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "script10.6",
"map" : "//element(*,DrugCodedType)/Strength"
},
{
"identity" : "v2",
"map" : "RXC-3-Component Amount & RXC-4-Component Units if medication: RXO-2-Requested Give Amount - Minimum & RXO-4-Requested Give Units / RXO-3-Requested Give Amount - Maximum & RXO-4-Requested Give Units / RXO-11-Requested Dispense Amount & RXO-12-Requested Dispense Units / RXE-3-Give Amount - Minimum & RXE-5-Give Units / RXE-4-Give Amount - Maximum & RXE-5-Give Units / RXE-10-Dispense Amount & RXE-10-Dispense Units"
},
{
"identity" : "rim",
"map" : ".quantity"
}]
},
{
"id" : "MedicationKnowledge.preparationInstruction",
"path" : "MedicationKnowledge.preparationInstruction",
"short" : "The instructions for preparing the medication",
"definition" : "The instructions for preparing the medication.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicationKnowledge.preparationInstruction",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "markdown"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "MedicationKnowledge.intendedRoute",
"path" : "MedicationKnowledge.intendedRoute",
"short" : "The intended or approved route of administration",
"definition" : "The intended or approved route of administration.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicationKnowledge.intendedRoute",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MedicationRoute"
}],
"strength" : "example",
"description" : "A coded concept defining the intended route of administration.",
"valueSet" : "http://hl7.org/fhir/ValueSet/route-codes"
}
},
{
"id" : "MedicationKnowledge.cost",
"path" : "MedicationKnowledge.cost",
"short" : "The pricing of the medication",
"definition" : "The price of the medication.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicationKnowledge.cost",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "MedicationKnowledge.cost.id",
"path" : "MedicationKnowledge.cost.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MedicationKnowledge.cost.extension",
"path" : "MedicationKnowledge.cost.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MedicationKnowledge.cost.modifierExtension",
"path" : "MedicationKnowledge.cost.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MedicationKnowledge.cost.type",
"path" : "MedicationKnowledge.cost.type",
"short" : "The category of the cost information",
"definition" : "The category of the cost information. For example, manufacturers' cost, patient cost, claim reimbursement cost, actual acquisition cost.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "MedicationKnowledge.cost.type",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "MedicationKnowledge.cost.source",
"path" : "MedicationKnowledge.cost.source",
"short" : "The source or owner for the price information",
"definition" : "The source or owner that assigns the price to the medication.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicationKnowledge.cost.source",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "MedicationKnowledge.cost.cost",
"path" : "MedicationKnowledge.cost.cost",
"short" : "The price of the medication",
"definition" : "The price of the medication.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "MedicationKnowledge.cost.cost",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "Money"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "MedicationKnowledge.monitoringProgram",
"path" : "MedicationKnowledge.monitoringProgram",
"short" : "Program under which a medication is reviewed",
"definition" : "The program under which the medication is reviewed.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicationKnowledge.monitoringProgram",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "MedicationKnowledge.monitoringProgram.id",
"path" : "MedicationKnowledge.monitoringProgram.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MedicationKnowledge.monitoringProgram.extension",
"path" : "MedicationKnowledge.monitoringProgram.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MedicationKnowledge.monitoringProgram.modifierExtension",
"path" : "MedicationKnowledge.monitoringProgram.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MedicationKnowledge.monitoringProgram.type",
"path" : "MedicationKnowledge.monitoringProgram.type",
"short" : "Type of program under which the medication is monitored",
"definition" : "Type of program under which the medication is monitored.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicationKnowledge.monitoringProgram.type",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "MedicationKnowledge.monitoringProgram.name",
"path" : "MedicationKnowledge.monitoringProgram.name",
"short" : "Name of the reviewing program",
"definition" : "Name of the reviewing program.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicationKnowledge.monitoringProgram.name",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "MedicationKnowledge.administrationGuidelines",
"path" : "MedicationKnowledge.administrationGuidelines",
"short" : "Guidelines for administration of the medication",
"definition" : "Guidelines for the administration of the medication.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicationKnowledge.administrationGuidelines",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "MedicationKnowledge.administrationGuidelines.id",
"path" : "MedicationKnowledge.administrationGuidelines.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MedicationKnowledge.administrationGuidelines.extension",
"path" : "MedicationKnowledge.administrationGuidelines.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MedicationKnowledge.administrationGuidelines.modifierExtension",
"path" : "MedicationKnowledge.administrationGuidelines.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MedicationKnowledge.administrationGuidelines.dosage",
"path" : "MedicationKnowledge.administrationGuidelines.dosage",
"short" : "Dosage for the medication for the specific guidelines",
"definition" : "Dosage for the medication for the specific guidelines.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicationKnowledge.administrationGuidelines.dosage",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "MedicationKnowledge.administrationGuidelines.dosage.id",
"path" : "MedicationKnowledge.administrationGuidelines.dosage.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MedicationKnowledge.administrationGuidelines.dosage.extension",
"path" : "MedicationKnowledge.administrationGuidelines.dosage.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MedicationKnowledge.administrationGuidelines.dosage.modifierExtension",
"path" : "MedicationKnowledge.administrationGuidelines.dosage.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MedicationKnowledge.administrationGuidelines.dosage.type",
"path" : "MedicationKnowledge.administrationGuidelines.dosage.type",
"short" : "Type of dosage",
"definition" : "The type of dosage (for example, prophylaxis, maintenance, therapeutic, etc.).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "MedicationKnowledge.administrationGuidelines.dosage.type",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "MedicationKnowledge.administrationGuidelines.dosage.dosage",
"path" : "MedicationKnowledge.administrationGuidelines.dosage.dosage",
"short" : "Dosage for the medication for the specific guidelines",
"definition" : "Dosage for the medication for the specific guidelines.",
"min" : 1,
"max" : "*",
"base" : {
"path" : "MedicationKnowledge.administrationGuidelines.dosage.dosage",
"min" : 1,
"max" : "*"
},
"type" : [{
"code" : "Dosage"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "MedicationKnowledge.administrationGuidelines.indication[x]",
"path" : "MedicationKnowledge.administrationGuidelines.indication[x]",
"short" : "Indication for use that apply to the specific administration guidelines",
"definition" : "Indication for use that apply to the specific administration guidelines.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicationKnowledge.administrationGuidelines.indication[x]",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
},
{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ObservationDefinition"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "MedicationKnowledge.administrationGuidelines.patientCharacteristics",
"path" : "MedicationKnowledge.administrationGuidelines.patientCharacteristics",
"short" : "Characteristics of the patient that are relevant to the administration guidelines",
"definition" : "Characteristics of the patient that are relevant to the administration guidelines (for example, height, weight, gender, etc.).",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicationKnowledge.administrationGuidelines.patientCharacteristics",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "MedicationKnowledge.administrationGuidelines.patientCharacteristics.id",
"path" : "MedicationKnowledge.administrationGuidelines.patientCharacteristics.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MedicationKnowledge.administrationGuidelines.patientCharacteristics.extension",
"path" : "MedicationKnowledge.administrationGuidelines.patientCharacteristics.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MedicationKnowledge.administrationGuidelines.patientCharacteristics.modifierExtension",
"path" : "MedicationKnowledge.administrationGuidelines.patientCharacteristics.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MedicationKnowledge.administrationGuidelines.patientCharacteristics.characteristic[x]",
"path" : "MedicationKnowledge.administrationGuidelines.patientCharacteristics.characteristic[x]",
"short" : "Specific characteristic that is relevant to the administration guideline",
"definition" : "Specific characteristic that is relevant to the administration guideline (e.g. height, weight, gender).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "MedicationKnowledge.administrationGuidelines.patientCharacteristics.characteristic[x]",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
},
{
"code" : "Quantity",
"profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "MedicationKnowledge.administrationGuidelines.patientCharacteristics.value",
"path" : "MedicationKnowledge.administrationGuidelines.patientCharacteristics.value",
"short" : "The specific characteristic",
"definition" : "The specific characteristic (e.g. height, weight, gender, etc.).",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicationKnowledge.administrationGuidelines.patientCharacteristics.value",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "MedicationKnowledge.medicineClassification",
"path" : "MedicationKnowledge.medicineClassification",
"short" : "Categorization of the medication within a formulary or classification system",
"definition" : "Categorization of the medication within a formulary or classification system.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicationKnowledge.medicineClassification",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "MedicationKnowledge.medicineClassification.id",
"path" : "MedicationKnowledge.medicineClassification.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MedicationKnowledge.medicineClassification.extension",
"path" : "MedicationKnowledge.medicineClassification.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MedicationKnowledge.medicineClassification.modifierExtension",
"path" : "MedicationKnowledge.medicineClassification.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MedicationKnowledge.medicineClassification.type",
"path" : "MedicationKnowledge.medicineClassification.type",
"short" : "The type of category for the medication (for example, therapeutic classification, therapeutic sub-classification)",
"definition" : "The type of category for the medication (for example, therapeutic classification, therapeutic sub-classification).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "MedicationKnowledge.medicineClassification.type",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "MedicationKnowledge.medicineClassification.classification",
"path" : "MedicationKnowledge.medicineClassification.classification",
"short" : "Specific category assigned to the medication",
"definition" : "Specific category assigned to the medication (e.g. anti-infective, anti-hypertensive, antibiotic, etc.).",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicationKnowledge.medicineClassification.classification",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "MedicationKnowledge.packaging",
"path" : "MedicationKnowledge.packaging",
"short" : "Details about packaged medications",
"definition" : "Information that only applies to packages (not products).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicationKnowledge.packaging",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "MedicationKnowledge.packaging.id",
"path" : "MedicationKnowledge.packaging.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MedicationKnowledge.packaging.extension",
"path" : "MedicationKnowledge.packaging.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MedicationKnowledge.packaging.modifierExtension",
"path" : "MedicationKnowledge.packaging.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MedicationKnowledge.packaging.type",
"path" : "MedicationKnowledge.packaging.type",
"short" : "A code that defines the specific type of packaging that the medication can be found in",
"definition" : "A code that defines the specific type of packaging that the medication can be found in (e.g. blister sleeve, tube, bottle).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicationKnowledge.packaging.type",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MedicationPackageType"
}],
"strength" : "example",
"description" : "A coded concept defining the type of packaging of a medication.",
"valueSet" : "http://hl7.org/fhir/ValueSet/medicationknowledge-package-type"
}
},
{
"id" : "MedicationKnowledge.packaging.quantity",
"path" : "MedicationKnowledge.packaging.quantity",
"short" : "The number of product units the package would contain if fully loaded",
"definition" : "The number of product units the package would contain if fully loaded.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicationKnowledge.packaging.quantity",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Quantity",
"profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "MedicationKnowledge.drugCharacteristic",
"path" : "MedicationKnowledge.drugCharacteristic",
"short" : "Specifies descriptive properties of the medicine",
"definition" : "Specifies descriptive properties of the medicine, such as color, shape, imprints, etc.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicationKnowledge.drugCharacteristic",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "MedicationKnowledge.drugCharacteristic.id",
"path" : "MedicationKnowledge.drugCharacteristic.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MedicationKnowledge.drugCharacteristic.extension",
"path" : "MedicationKnowledge.drugCharacteristic.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MedicationKnowledge.drugCharacteristic.modifierExtension",
"path" : "MedicationKnowledge.drugCharacteristic.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MedicationKnowledge.drugCharacteristic.type",
"path" : "MedicationKnowledge.drugCharacteristic.type",
"short" : "Code specifying the type of characteristic of medication",
"definition" : "A code specifying which characteristic of the medicine is being described (for example, colour, shape, imprint).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicationKnowledge.drugCharacteristic.type",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MedicationCharacteristic"
}],
"strength" : "example",
"description" : "A coded concept defining the characteristic types of a medication.",
"valueSet" : "http://hl7.org/fhir/ValueSet/medicationknowledge-characteristic"
}
},
{
"id" : "MedicationKnowledge.drugCharacteristic.value[x]",
"path" : "MedicationKnowledge.drugCharacteristic.value[x]",
"short" : "Description of the characteristic",
"definition" : "Description of the characteristic.",
"comment" : "The description should be provided as a CodeableConcept, SimpleQuantity or an image. The description can be a string only when these others are not available.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicationKnowledge.drugCharacteristic.value[x]",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
},
{
"code" : "string"
},
{
"code" : "Quantity",
"profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
},
{
"code" : "base64Binary"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "MedicationKnowledge.contraindication",
"path" : "MedicationKnowledge.contraindication",
"short" : "Potential clinical issue with or between medication(s)",
"definition" : "Potential clinical issue with or between medication(s) (for example, drug-drug interaction, drug-disease contraindication, drug-allergy interaction, etc.).",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicationKnowledge.contraindication",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/DetectedIssue"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "MedicationKnowledge.regulatory",
"path" : "MedicationKnowledge.regulatory",
"short" : "Regulatory information about a medication",
"definition" : "Regulatory information about a medication.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicationKnowledge.regulatory",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "MedicationKnowledge.regulatory.id",
"path" : "MedicationKnowledge.regulatory.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MedicationKnowledge.regulatory.extension",
"path" : "MedicationKnowledge.regulatory.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MedicationKnowledge.regulatory.modifierExtension",
"path" : "MedicationKnowledge.regulatory.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MedicationKnowledge.regulatory.regulatoryAuthority",
"path" : "MedicationKnowledge.regulatory.regulatoryAuthority",
"short" : "Specifies the authority of the regulation",
"definition" : "The authority that is specifying the regulations.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "MedicationKnowledge.regulatory.regulatoryAuthority",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "MedicationKnowledge.regulatory.substitution",
"path" : "MedicationKnowledge.regulatory.substitution",
"short" : "Specifies if changes are allowed when dispensing a medication from a regulatory perspective",
"definition" : "Specifies if changes are allowed when dispensing a medication from a regulatory perspective.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicationKnowledge.regulatory.substitution",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "MedicationKnowledge.regulatory.substitution.id",
"path" : "MedicationKnowledge.regulatory.substitution.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MedicationKnowledge.regulatory.substitution.extension",
"path" : "MedicationKnowledge.regulatory.substitution.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MedicationKnowledge.regulatory.substitution.modifierExtension",
"path" : "MedicationKnowledge.regulatory.substitution.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MedicationKnowledge.regulatory.substitution.type",
"path" : "MedicationKnowledge.regulatory.substitution.type",
"short" : "Specifies the type of substitution allowed",
"definition" : "Specifies the type of substitution allowed.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "MedicationKnowledge.regulatory.substitution.type",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "MedicationKnowledge.regulatory.substitution.allowed",
"path" : "MedicationKnowledge.regulatory.substitution.allowed",
"short" : "Specifies if regulation allows for changes in the medication when dispensing",
"definition" : "Specifies if regulation allows for changes in the medication when dispensing.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "MedicationKnowledge.regulatory.substitution.allowed",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "MedicationKnowledge.regulatory.schedule",
"path" : "MedicationKnowledge.regulatory.schedule",
"short" : "Specifies the schedule of a medication in jurisdiction",
"definition" : "Specifies the schedule of a medication in jurisdiction.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicationKnowledge.regulatory.schedule",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "MedicationKnowledge.regulatory.schedule.id",
"path" : "MedicationKnowledge.regulatory.schedule.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MedicationKnowledge.regulatory.schedule.extension",
"path" : "MedicationKnowledge.regulatory.schedule.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MedicationKnowledge.regulatory.schedule.modifierExtension",
"path" : "MedicationKnowledge.regulatory.schedule.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MedicationKnowledge.regulatory.schedule.schedule",
"path" : "MedicationKnowledge.regulatory.schedule.schedule",
"short" : "Specifies the specific drug schedule",
"definition" : "Specifies the specific drug schedule.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "MedicationKnowledge.regulatory.schedule.schedule",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "MedicationKnowledge.regulatory.maxDispense",
"path" : "MedicationKnowledge.regulatory.maxDispense",
"short" : "The maximum number of units of the medication that can be dispensed in a period",
"definition" : "The maximum number of units of the medication that can be dispensed in a period.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicationKnowledge.regulatory.maxDispense",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "MedicationKnowledge.regulatory.maxDispense.id",
"path" : "MedicationKnowledge.regulatory.maxDispense.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MedicationKnowledge.regulatory.maxDispense.extension",
"path" : "MedicationKnowledge.regulatory.maxDispense.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MedicationKnowledge.regulatory.maxDispense.modifierExtension",
"path" : "MedicationKnowledge.regulatory.maxDispense.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MedicationKnowledge.regulatory.maxDispense.quantity",
"path" : "MedicationKnowledge.regulatory.maxDispense.quantity",
"short" : "The maximum number of units of the medication that can be dispensed",
"definition" : "The maximum number of units of the medication that can be dispensed.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "MedicationKnowledge.regulatory.maxDispense.quantity",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "Quantity",
"profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "MedicationKnowledge.regulatory.maxDispense.period",
"path" : "MedicationKnowledge.regulatory.maxDispense.period",
"short" : "The period that applies to the maximum number of units",
"definition" : "The period that applies to the maximum number of units.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicationKnowledge.regulatory.maxDispense.period",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Duration"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "MedicationKnowledge.kinetics",
"path" : "MedicationKnowledge.kinetics",
"short" : "The time course of drug absorption, distribution, metabolism and excretion of a medication from the body",
"definition" : "The time course of drug absorption, distribution, metabolism and excretion of a medication from the body.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicationKnowledge.kinetics",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "MedicationKnowledge.kinetics.id",
"path" : "MedicationKnowledge.kinetics.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MedicationKnowledge.kinetics.extension",
"path" : "MedicationKnowledge.kinetics.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MedicationKnowledge.kinetics.modifierExtension",
"path" : "MedicationKnowledge.kinetics.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MedicationKnowledge.kinetics.areaUnderCurve",
"path" : "MedicationKnowledge.kinetics.areaUnderCurve",
"short" : "The drug concentration measured at certain discrete points in time",
"definition" : "The drug concentration measured at certain discrete points in time.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicationKnowledge.kinetics.areaUnderCurve",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Quantity",
"profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "MedicationKnowledge.kinetics.lethalDose50",
"path" : "MedicationKnowledge.kinetics.lethalDose50",
"short" : "The median lethal dose of a drug",
"definition" : "The median lethal dose of a drug.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicationKnowledge.kinetics.lethalDose50",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Quantity",
"profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "MedicationKnowledge.kinetics.halfLifePeriod",
"path" : "MedicationKnowledge.kinetics.halfLifePeriod",
"short" : "Time required for concentration in the body to decrease by half",
"definition" : "The time required for any specified property (e.g., the concentration of a substance in the body) to decrease by half.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicationKnowledge.kinetics.halfLifePeriod",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Duration"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
}]
},
"differential" : {
"element" : [{
"id" : "MedicationKnowledge",
"path" : "MedicationKnowledge",
"short" : "Definition of Medication Knowledge",
"definition" : "Information about a medication that is used to support knowledge.",
"min" : 0,
"max" : "*",
"mapping" : [{
"identity" : "rim",
"map" : "Todo"
}]
},
{
"id" : "MedicationKnowledge.code",
"path" : "MedicationKnowledge.code",
"short" : "Code that identifies this medication",
"definition" : "A code that specifies this medication, or a textual description if no code is available. Usage note: This could be a standard medication code such as a code from RxNorm, SNOMED CT, IDMP etc. It could also be a national or local formulary code, optionally with translations to other code systems.",
"comment" : "Depending on the context of use, the code that was actually selected by the user (prescriber, dispenser, etc.) will have the coding.userSelected set to true. As described in the coding datatype: \"A coding may be marked as a \"userSelected\" if a user selected the particular coded value in a user interface (e.g. the user selects an item in a pick-list). If a user selected coding exists, it is the preferred choice for performing translations etc. Other codes can only be literal translations to alternative code systems, or codes at a lower level of granularity (e.g. a generic code for a vendor-specific primary one).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MedicationFormalRepresentation"
}],
"strength" : "example",
"description" : "A coded concept that defines the type of a medication.",
"valueSet" : "http://hl7.org/fhir/ValueSet/medication-codes"
},
"mapping" : [{
"identity" : "script10.6",
"map" : "coding.code = //element(*,MedicationType)/DrugCoded/ProductCode\r\rcoding.system = //element(*,MedicationType)/DrugCoded/ProductCodeQualifier\r\rcoding.display = //element(*,MedicationType)/DrugDescription"
},
{
"identity" : "w5",
"map" : "FiveWs.class"
},
{
"identity" : "v2",
"map" : "RXO-1.1-Requested Give Code.code / RXE-2.1-Give Code.code / RXD-2.1-Dispense/Give Code.code / RXG-4.1-Give Code.code /RXA-5.1-Administered Code.code / RXC-2.1 Component Code"
},
{
"identity" : "rim",
"map" : ".code"
}]
},
{
"id" : "MedicationKnowledge.status",
"path" : "MedicationKnowledge.status",
"short" : "active | inactive | entered-in-error",
"definition" : "A code to indicate if the medication is in active use. The status refers to the validity about the information of the medication and not to its medicinal properties.",
"comment" : "This status is intended to identify if the medication in a local system is in active use within a drug database or inventory. For example, a pharmacy system may create a new drug file record for a compounded product \"ABC Hospital Special Cream\" with an active status. At some point in the future, it may be determined that the drug record was created with an error and the status is changed to \"entered in error\". This status is not intended to specify if a medication is part of a particular formulary. It is possible that the drug record may be referenced by multiple formularies or catalogues and each of those entries would have a separate status.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isModifier" : true,
"isModifierReason" : "This element changes the interpretation of all descriptive attributes.",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MedicationKnowledgeStatus"
}],
"strength" : "required",
"description" : "A coded concept defining if the medication is in active use.",
"valueSet" : "http://hl7.org/fhir/ValueSet/medicationknowledge-status|4.0.1"
},
"mapping" : [{
"identity" : "rim",
"map" : ".statusCode"
}]
},
{
"id" : "MedicationKnowledge.manufacturer",
"path" : "MedicationKnowledge.manufacturer",
"short" : "Manufacturer of the item",
"definition" : "Describes the details of the manufacturer of the medication product. This is not intended to represent the distributor of a medication product.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "script10.6",
"map" : "no mapping"
},
{
"identity" : "w5",
"map" : "FiveWs.actor"
},
{
"identity" : "v2",
"map" : "RXD-20-Substance Manufacturer Name / RXG-21-Substance Manufacturer Name / RXA-17-Substance Manufacturer Name"
},
{
"identity" : "rim",
"map" : ".player.scopingRole[typeCode=MANU].scoper"
}]
},
{
"id" : "MedicationKnowledge.doseForm",
"path" : "MedicationKnowledge.doseForm",
"short" : "powder | tablets | capsule +",
"definition" : "Describes the form of the item. Powder; tablets; capsule.",
"comment" : "When Medication is referenced from MedicationRequest, this is the ordered form. When Medication is referenced within MedicationDispense, this is the dispensed form. When Medication is referenced within MedicationAdministration, this is administered form.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MedicationForm"
}],
"strength" : "example",
"description" : "A coded concept defining the form of a medication.",
"valueSet" : "http://hl7.org/fhir/ValueSet/medication-form-codes"
},
"mapping" : [{
"identity" : "script10.6",
"map" : "coding.code = //element(*,DrugCodedType)/FormCode\r\rcoding.system = //element(*,DrugCodedType)/FormSourceCode"
},
{
"identity" : "v2",
"map" : "RXO-5-Requested Dosage Form / RXE-6-Give Dosage Form / RXD-6-Actual Dosage Form / RXG-8-Give Dosage Form / RXA-8-Administered Dosage Form"
},
{
"identity" : "rim",
"map" : ".formCode"
}]
},
{
"id" : "MedicationKnowledge.amount",
"path" : "MedicationKnowledge.amount",
"short" : "Amount of drug in package",
"definition" : "Specific amount of the drug in the packaged product. For example, when specifying a product that has the same strength (For example, Insulin glargine 100 unit per mL solution for injection), this attribute provides additional clarification of the package amount (For example, 3 mL, 10mL, etc.).",
"comment" : "This is the quantity of medication in a package. To specify the strength of the medication, the Ingredient.strength attribute is used.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Quantity",
"profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : ".quantity"
}]
},
{
"id" : "MedicationKnowledge.synonym",
"path" : "MedicationKnowledge.synonym",
"short" : "Additional names for a medication",
"definition" : "Additional names for a medication, for example, the name(s) given to a medication in different countries. For example, acetaminophen and paracetamol or salbutamol and albuterol.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "MedicationKnowledge.relatedMedicationKnowledge",
"path" : "MedicationKnowledge.relatedMedicationKnowledge",
"short" : "Associated or related medication information",
"definition" : "Associated or related knowledge about a medication.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "MedicationKnowledge.relatedMedicationKnowledge.type",
"path" : "MedicationKnowledge.relatedMedicationKnowledge.type",
"short" : "Category of medicationKnowledge",
"definition" : "The category of the associated medication knowledge reference.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}]
},
{
"id" : "MedicationKnowledge.relatedMedicationKnowledge.reference",
"path" : "MedicationKnowledge.relatedMedicationKnowledge.reference",
"short" : "Associated documentation about the associated medication knowledge",
"definition" : "Associated documentation about the associated medication knowledge.",
"min" : 1,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/MedicationKnowledge"]
}]
},
{
"id" : "MedicationKnowledge.associatedMedication",
"path" : "MedicationKnowledge.associatedMedication",
"short" : "A medication resource that is associated with this medication",
"definition" : "Associated or related medications. For example, if the medication is a branded product (e.g. Crestor), this is the Therapeutic Moeity (e.g. Rosuvastatin) or if this is a generic medication (e.g. Rosuvastatin), this would link to a branded product (e.g. Crestor).",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Medication"]
}]
},
{
"id" : "MedicationKnowledge.productType",
"path" : "MedicationKnowledge.productType",
"short" : "Category of the medication or product",
"definition" : "Category of the medication or product (e.g. branded product, therapeutic moeity, generic product, innovator product, etc.).",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}]
},
{
"id" : "MedicationKnowledge.monograph",
"path" : "MedicationKnowledge.monograph",
"short" : "Associated documentation about the medication",
"definition" : "Associated documentation about the medication.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "MedicationKnowledge.monograph.type",
"path" : "MedicationKnowledge.monograph.type",
"short" : "The category of medication document",
"definition" : "The category of documentation about the medication. (e.g. professional monograph, patient education monograph).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}]
},
{
"id" : "MedicationKnowledge.monograph.source",
"path" : "MedicationKnowledge.monograph.source",
"short" : "Associated documentation about the medication",
"definition" : "Associated documentation about the medication.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/DocumentReference",
"http://hl7.org/fhir/StructureDefinition/Media"]
}]
},
{
"id" : "MedicationKnowledge.ingredient",
"path" : "MedicationKnowledge.ingredient",
"short" : "Active or inactive ingredient",
"definition" : "Identifies a particular constituent of interest in the product.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "MedicationKnowledge.ingredient.item[x]",
"path" : "MedicationKnowledge.ingredient.item[x]",
"short" : "Medication(s) or substance(s) contained in the medication",
"definition" : "The actual ingredient - either a substance (simple ingredient) or another medication.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
},
{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Substance"]
}],
"mapping" : [{
"identity" : "script10.6",
"map" : "coding.code = //element(*,MedicationType)/DrugCoded/ProductCode\r\rcoding.system = //element(*,MedicationType)/DrugCoded/ProductCodeQualifier\r\rcoding.display = //element(*,MedicationType)/DrugDescription"
},
{
"identity" : "v2",
"map" : "RXC-2-Component Code if medication: RXO-1-Requested Give Code / RXE-2-Give Code / RXD-2-Dispense/Give Code / RXG-4-Give Code / RXA-5-Administered Code"
},
{
"identity" : "rim",
"map" : ".player"
}]
},
{
"id" : "MedicationKnowledge.ingredient.isActive",
"path" : "MedicationKnowledge.ingredient.isActive",
"short" : "Active ingredient indicator",
"definition" : "Indication of whether this ingredient affects the therapeutic action of the drug.",
"requirements" : "True indicates that the ingredient affects the therapeutic action of the drug (i.e. active). \rFalse indicates that the ingredient does not affect the therapeutic action of the drug (i.e. inactive).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "boolean"
}],
"mapping" : [{
"identity" : "rim",
"map" : "NA"
}]
},
{
"id" : "MedicationKnowledge.ingredient.strength",
"path" : "MedicationKnowledge.ingredient.strength",
"short" : "Quantity of ingredient present",
"definition" : "Specifies how many (or how much) of the items there are in this Medication. For example, 250 mg per tablet. This is expressed as a ratio where the numerator is 250mg and the denominator is 1 tablet.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Ratio"
}],
"mapping" : [{
"identity" : "script10.6",
"map" : "//element(*,DrugCodedType)/Strength"
},
{
"identity" : "v2",
"map" : "RXC-3-Component Amount & RXC-4-Component Units if medication: RXO-2-Requested Give Amount - Minimum & RXO-4-Requested Give Units / RXO-3-Requested Give Amount - Maximum & RXO-4-Requested Give Units / RXO-11-Requested Dispense Amount & RXO-12-Requested Dispense Units / RXE-3-Give Amount - Minimum & RXE-5-Give Units / RXE-4-Give Amount - Maximum & RXE-5-Give Units / RXE-10-Dispense Amount & RXE-10-Dispense Units"
},
{
"identity" : "rim",
"map" : ".quantity"
}]
},
{
"id" : "MedicationKnowledge.preparationInstruction",
"path" : "MedicationKnowledge.preparationInstruction",
"short" : "The instructions for preparing the medication",
"definition" : "The instructions for preparing the medication.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "markdown"
}]
},
{
"id" : "MedicationKnowledge.intendedRoute",
"path" : "MedicationKnowledge.intendedRoute",
"short" : "The intended or approved route of administration",
"definition" : "The intended or approved route of administration.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MedicationRoute"
}],
"strength" : "example",
"description" : "A coded concept defining the intended route of administration.",
"valueSet" : "http://hl7.org/fhir/ValueSet/route-codes"
}
},
{
"id" : "MedicationKnowledge.cost",
"path" : "MedicationKnowledge.cost",
"short" : "The pricing of the medication",
"definition" : "The price of the medication.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "MedicationKnowledge.cost.type",
"path" : "MedicationKnowledge.cost.type",
"short" : "The category of the cost information",
"definition" : "The category of the cost information. For example, manufacturers' cost, patient cost, claim reimbursement cost, actual acquisition cost.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}]
},
{
"id" : "MedicationKnowledge.cost.source",
"path" : "MedicationKnowledge.cost.source",
"short" : "The source or owner for the price information",
"definition" : "The source or owner that assigns the price to the medication.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}]
},
{
"id" : "MedicationKnowledge.cost.cost",
"path" : "MedicationKnowledge.cost.cost",
"short" : "The price of the medication",
"definition" : "The price of the medication.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "Money"
}]
},
{
"id" : "MedicationKnowledge.monitoringProgram",
"path" : "MedicationKnowledge.monitoringProgram",
"short" : "Program under which a medication is reviewed",
"definition" : "The program under which the medication is reviewed.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "MedicationKnowledge.monitoringProgram.type",
"path" : "MedicationKnowledge.monitoringProgram.type",
"short" : "Type of program under which the medication is monitored",
"definition" : "Type of program under which the medication is monitored.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}]
},
{
"id" : "MedicationKnowledge.monitoringProgram.name",
"path" : "MedicationKnowledge.monitoringProgram.name",
"short" : "Name of the reviewing program",
"definition" : "Name of the reviewing program.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}]
},
{
"id" : "MedicationKnowledge.administrationGuidelines",
"path" : "MedicationKnowledge.administrationGuidelines",
"short" : "Guidelines for administration of the medication",
"definition" : "Guidelines for the administration of the medication.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "MedicationKnowledge.administrationGuidelines.dosage",
"path" : "MedicationKnowledge.administrationGuidelines.dosage",
"short" : "Dosage for the medication for the specific guidelines",
"definition" : "Dosage for the medication for the specific guidelines.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "MedicationKnowledge.administrationGuidelines.dosage.type",
"path" : "MedicationKnowledge.administrationGuidelines.dosage.type",
"short" : "Type of dosage",
"definition" : "The type of dosage (for example, prophylaxis, maintenance, therapeutic, etc.).",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}]
},
{
"id" : "MedicationKnowledge.administrationGuidelines.dosage.dosage",
"path" : "MedicationKnowledge.administrationGuidelines.dosage.dosage",
"short" : "Dosage for the medication for the specific guidelines",
"definition" : "Dosage for the medication for the specific guidelines.",
"min" : 1,
"max" : "*",
"type" : [{
"code" : "Dosage"
}]
},
{
"id" : "MedicationKnowledge.administrationGuidelines.indication[x]",
"path" : "MedicationKnowledge.administrationGuidelines.indication[x]",
"short" : "Indication for use that apply to the specific administration guidelines",
"definition" : "Indication for use that apply to the specific administration guidelines.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
},
{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ObservationDefinition"]
}]
},
{
"id" : "MedicationKnowledge.administrationGuidelines.patientCharacteristics",
"path" : "MedicationKnowledge.administrationGuidelines.patientCharacteristics",
"short" : "Characteristics of the patient that are relevant to the administration guidelines",
"definition" : "Characteristics of the patient that are relevant to the administration guidelines (for example, height, weight, gender, etc.).",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "MedicationKnowledge.administrationGuidelines.patientCharacteristics.characteristic[x]",
"path" : "MedicationKnowledge.administrationGuidelines.patientCharacteristics.characteristic[x]",
"short" : "Specific characteristic that is relevant to the administration guideline",
"definition" : "Specific characteristic that is relevant to the administration guideline (e.g. height, weight, gender).",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
},
{
"code" : "Quantity",
"profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
}]
},
{
"id" : "MedicationKnowledge.administrationGuidelines.patientCharacteristics.value",
"path" : "MedicationKnowledge.administrationGuidelines.patientCharacteristics.value",
"short" : "The specific characteristic",
"definition" : "The specific characteristic (e.g. height, weight, gender, etc.).",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "string"
}]
},
{
"id" : "MedicationKnowledge.medicineClassification",
"path" : "MedicationKnowledge.medicineClassification",
"short" : "Categorization of the medication within a formulary or classification system",
"definition" : "Categorization of the medication within a formulary or classification system.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "MedicationKnowledge.medicineClassification.type",
"path" : "MedicationKnowledge.medicineClassification.type",
"short" : "The type of category for the medication (for example, therapeutic classification, therapeutic sub-classification)",
"definition" : "The type of category for the medication (for example, therapeutic classification, therapeutic sub-classification).",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}]
},
{
"id" : "MedicationKnowledge.medicineClassification.classification",
"path" : "MedicationKnowledge.medicineClassification.classification",
"short" : "Specific category assigned to the medication",
"definition" : "Specific category assigned to the medication (e.g. anti-infective, anti-hypertensive, antibiotic, etc.).",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}]
},
{
"id" : "MedicationKnowledge.packaging",
"path" : "MedicationKnowledge.packaging",
"short" : "Details about packaged medications",
"definition" : "Information that only applies to packages (not products).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "MedicationKnowledge.packaging.type",
"path" : "MedicationKnowledge.packaging.type",
"short" : "A code that defines the specific type of packaging that the medication can be found in",
"definition" : "A code that defines the specific type of packaging that the medication can be found in (e.g. blister sleeve, tube, bottle).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MedicationPackageType"
}],
"strength" : "example",
"description" : "A coded concept defining the type of packaging of a medication.",
"valueSet" : "http://hl7.org/fhir/ValueSet/medicationknowledge-package-type"
}
},
{
"id" : "MedicationKnowledge.packaging.quantity",
"path" : "MedicationKnowledge.packaging.quantity",
"short" : "The number of product units the package would contain if fully loaded",
"definition" : "The number of product units the package would contain if fully loaded.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Quantity",
"profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
}]
},
{
"id" : "MedicationKnowledge.drugCharacteristic",
"path" : "MedicationKnowledge.drugCharacteristic",
"short" : "Specifies descriptive properties of the medicine",
"definition" : "Specifies descriptive properties of the medicine, such as color, shape, imprints, etc.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "MedicationKnowledge.drugCharacteristic.type",
"path" : "MedicationKnowledge.drugCharacteristic.type",
"short" : "Code specifying the type of characteristic of medication",
"definition" : "A code specifying which characteristic of the medicine is being described (for example, colour, shape, imprint).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MedicationCharacteristic"
}],
"strength" : "example",
"description" : "A coded concept defining the characteristic types of a medication.",
"valueSet" : "http://hl7.org/fhir/ValueSet/medicationknowledge-characteristic"
}
},
{
"id" : "MedicationKnowledge.drugCharacteristic.value[x]",
"path" : "MedicationKnowledge.drugCharacteristic.value[x]",
"short" : "Description of the characteristic",
"definition" : "Description of the characteristic.",
"comment" : "The description should be provided as a CodeableConcept, SimpleQuantity or an image. The description can be a string only when these others are not available.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
},
{
"code" : "string"
},
{
"code" : "Quantity",
"profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
},
{
"code" : "base64Binary"
}]
},
{
"id" : "MedicationKnowledge.contraindication",
"path" : "MedicationKnowledge.contraindication",
"short" : "Potential clinical issue with or between medication(s)",
"definition" : "Potential clinical issue with or between medication(s) (for example, drug-drug interaction, drug-disease contraindication, drug-allergy interaction, etc.).",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/DetectedIssue"]
}]
},
{
"id" : "MedicationKnowledge.regulatory",
"path" : "MedicationKnowledge.regulatory",
"short" : "Regulatory information about a medication",
"definition" : "Regulatory information about a medication.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "MedicationKnowledge.regulatory.regulatoryAuthority",
"path" : "MedicationKnowledge.regulatory.regulatoryAuthority",
"short" : "Specifies the authority of the regulation",
"definition" : "The authority that is specifying the regulations.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization"]
}]
},
{
"id" : "MedicationKnowledge.regulatory.substitution",
"path" : "MedicationKnowledge.regulatory.substitution",
"short" : "Specifies if changes are allowed when dispensing a medication from a regulatory perspective",
"definition" : "Specifies if changes are allowed when dispensing a medication from a regulatory perspective.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "MedicationKnowledge.regulatory.substitution.type",
"path" : "MedicationKnowledge.regulatory.substitution.type",
"short" : "Specifies the type of substitution allowed",
"definition" : "Specifies the type of substitution allowed.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}]
},
{
"id" : "MedicationKnowledge.regulatory.substitution.allowed",
"path" : "MedicationKnowledge.regulatory.substitution.allowed",
"short" : "Specifies if regulation allows for changes in the medication when dispensing",
"definition" : "Specifies if regulation allows for changes in the medication when dispensing.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "boolean"
}]
},
{
"id" : "MedicationKnowledge.regulatory.schedule",
"path" : "MedicationKnowledge.regulatory.schedule",
"short" : "Specifies the schedule of a medication in jurisdiction",
"definition" : "Specifies the schedule of a medication in jurisdiction.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "MedicationKnowledge.regulatory.schedule.schedule",
"path" : "MedicationKnowledge.regulatory.schedule.schedule",
"short" : "Specifies the specific drug schedule",
"definition" : "Specifies the specific drug schedule.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}]
},
{
"id" : "MedicationKnowledge.regulatory.maxDispense",
"path" : "MedicationKnowledge.regulatory.maxDispense",
"short" : "The maximum number of units of the medication that can be dispensed in a period",
"definition" : "The maximum number of units of the medication that can be dispensed in a period.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "MedicationKnowledge.regulatory.maxDispense.quantity",
"path" : "MedicationKnowledge.regulatory.maxDispense.quantity",
"short" : "The maximum number of units of the medication that can be dispensed",
"definition" : "The maximum number of units of the medication that can be dispensed.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "Quantity",
"profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
}]
},
{
"id" : "MedicationKnowledge.regulatory.maxDispense.period",
"path" : "MedicationKnowledge.regulatory.maxDispense.period",
"short" : "The period that applies to the maximum number of units",
"definition" : "The period that applies to the maximum number of units.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Duration"
}]
},
{
"id" : "MedicationKnowledge.kinetics",
"path" : "MedicationKnowledge.kinetics",
"short" : "The time course of drug absorption, distribution, metabolism and excretion of a medication from the body",
"definition" : "The time course of drug absorption, distribution, metabolism and excretion of a medication from the body.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "MedicationKnowledge.kinetics.areaUnderCurve",
"path" : "MedicationKnowledge.kinetics.areaUnderCurve",
"short" : "The drug concentration measured at certain discrete points in time",
"definition" : "The drug concentration measured at certain discrete points in time.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Quantity",
"profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
}]
},
{
"id" : "MedicationKnowledge.kinetics.lethalDose50",
"path" : "MedicationKnowledge.kinetics.lethalDose50",
"short" : "The median lethal dose of a drug",
"definition" : "The median lethal dose of a drug.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Quantity",
"profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
}]
},
{
"id" : "MedicationKnowledge.kinetics.halfLifePeriod",
"path" : "MedicationKnowledge.kinetics.halfLifePeriod",
"short" : "Time required for concentration in the body to decrease by half",
"definition" : "The time required for any specified property (e.g., the concentration of a substance in the body) to decrease by half.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Duration"
}]
}]
}
}
},
{
"fullUrl" : "http://hl7.org/fhir/StructureDefinition/MedicationRequest",
"resource" : {
"resourceType" : "StructureDefinition",
"id" : "MedicationRequest",
"meta" : {
"lastUpdated" : "2019-11-01T09:29:23.356+11:00"
},
"text" : {
"status" : "generated",
"div" : "Name Flags Card. Type Description & Constraints MedicationRequest TU DomainResource Ordering of medication for patient or group
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension identifier 0..* Identifier External ids for this request
status ?!Σ 1..1 code active | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown
Medicationrequest status (Required) statusReason 0..1 CodeableConcept Reason for current status
Medication request status reason codes (Example) intent ?!Σ 1..1 code proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
Medication request intent (Required) category 0..* CodeableConcept Type of medication usage
Medication request category codes (Example)
priority Σ 0..1 code routine | urgent | asap | stat
Request priority (Required) doNotPerform ?!Σ 0..1 boolean True if request is prohibiting action reported[x] Σ 0..1 Reported rather than primary record reportedBoolean boolean reportedReference Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization) medication[x] Σ 1..1 Medication to be taken
SNOMED CT Medication Codes (Example) medicationCodeableConcept CodeableConcept medicationReference Reference(Medication) subject Σ 1..1 Reference(Patient | Group) Who or group medication request is for encounter 0..1 Reference(Encounter) Encounter created as part of encounter/admission/stay supportingInformation 0..* Reference(Any) Information to support ordering of the medication
authoredOn Σ 0..1 dateTime When request was initially authored requester Σ 0..1 Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) Who/What requested the Request performer 0..1 Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson | CareTeam) Intended performer of administration performerType Σ 0..1 CodeableConcept Desired kind of performer of the medication administration
Procedure Performer Role Codes (Example) recorder 0..1 Reference(Practitioner | PractitionerRole) Person who entered the request reasonCode 0..* CodeableConcept Reason or indication for ordering or not ordering the medication
Condition/Problem/Diagnosis Codes (Example)
reasonReference 0..* Reference(Condition | Observation) Condition or observation that supports why the prescription is being written
instantiatesCanonical Σ 0..* canonical() Instantiates FHIR protocol or definition
instantiatesUri Σ 0..* uri Instantiates external protocol or definition
basedOn Σ 0..* Reference(CarePlan | MedicationRequest | ServiceRequest | ImmunizationRecommendation) What request fulfills
groupIdentifier Σ 0..1 Identifier Composite request this is part of courseOfTherapyType 0..1 CodeableConcept Overall pattern of medication administration
Medication request course of therapy codes (Example) insurance 0..* Reference(Coverage | ClaimResponse) Associated insurance coverage
note 0..* Annotation Information about the prescription
dosageInstruction 0..* Dosage How the medication should be taken
dispenseRequest 0..1 BackboneElement Medication supply authorization initialFill 0..1 BackboneElement First fill details quantity 0..1 SimpleQuantity First fill quantity duration 0..1 Duration First fill duration dispenseInterval 0..1 Duration Minimum period of time between dispenses validityPeriod 0..1 Period Time period supply is authorized for numberOfRepeatsAllowed 0..1 unsignedInt Number of refills authorized quantity 0..1 SimpleQuantity Amount of medication to supply per dispense expectedSupplyDuration 0..1 Duration Number of days supply per dispense performer 0..1 Reference(Organization) Intended dispenser substitution 0..1 BackboneElement Any restrictions on medication substitution allowed[x] 1..1 Whether substitution is allowed or not
V3 Value SetActSubstanceAdminSubstitutionCode (Example) allowedBoolean boolean allowedCodeableConcept CodeableConcept reason 0..1 CodeableConcept Why should (not) substitution be made
V3 Value SetSubstanceAdminSubstitutionReason (Example) priorPrescription 0..1 Reference(MedicationRequest) An order/prescription that is being replaced detectedIssue 0..* Reference(DetectedIssue) Clinical Issue with action
eventHistory 0..* Reference(Provenance) A list of events of interest in the lifecycle
Documentation for this format
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Clinical.Medications"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 3
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "patient"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "phx"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/MedicationRequest",
"version" : "4.0.1",
"name" : "MedicationRequest",
"status" : "draft",
"date" : "2019-11-01T09:29:23+11:00",
"publisher" : "Health Level Seven International (Pharmacy)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/medication/index.cfm"
}]
}],
"description" : "An order or request for both supply of the medication and the instructions for administration of the medication to a patient. The resource is called \"MedicationRequest\" rather than \"MedicationPrescription\" or \"MedicationOrder\" to generalize the use across inpatient and outpatient settings, including care plans, etc., and to harmonize with workflow patterns.",
"fhirVersion" : "4.0.1",
"mapping" : [{
"identity" : "workflow",
"uri" : "http://hl7.org/fhir/workflow",
"name" : "Workflow Pattern"
},
{
"identity" : "script10.6",
"uri" : "http://ncpdp.org/SCRIPT10_6",
"name" : "Mapping to NCPDP SCRIPT 10.6"
},
{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/fivews",
"name" : "FiveWs Pattern Mapping"
},
{
"identity" : "v2",
"uri" : "http://hl7.org/v2",
"name" : "HL7 v2 Mapping"
}],
"kind" : "resource",
"abstract" : false,
"type" : "MedicationRequest",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "MedicationRequest",
"path" : "MedicationRequest",
"short" : "Ordering of medication for patient or group",
"definition" : "An order or request for both supply of the medication and the instructions for administration of the medication to a patient. The resource is called \"MedicationRequest\" rather than \"MedicationPrescription\" or \"MedicationOrder\" to generalize the use across inpatient and outpatient settings, including care plans, etc., and to harmonize with workflow patterns.",
"alias" : ["Prescription",
"Order"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicationRequest",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "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",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.`div`.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "workflow",
"map" : "Request"
},
{
"identity" : "script10.6",
"map" : "Message/Body/NewRx"
},
{
"identity" : "rim",
"map" : "CombinedMedicationRequest"
}]
},
{
"id" : "MedicationRequest.id",
"path" : "MedicationRequest.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicationRequest.meta",
"path" : "MedicationRequest.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicationRequest.implicitRules",
"path" : "MedicationRequest.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "MedicationRequest.language",
"path" : "MedicationRequest.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "MedicationRequest.text",
"path" : "MedicationRequest.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "MedicationRequest.contained",
"path" : "MedicationRequest.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MedicationRequest.extension",
"path" : "MedicationRequest.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MedicationRequest.modifierExtension",
"path" : "MedicationRequest.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MedicationRequest.identifier",
"path" : "MedicationRequest.identifier",
"short" : "External ids for this request",
"definition" : "Identifiers associated with this medication request that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server.",
"comment" : "This is a business identifier, not a resource identifier.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicationRequest.identifier",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Identifier"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.identifier"
},
{
"identity" : "script10.6",
"map" : "Message/Header/PrescriberOrderNumber"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "v2",
"map" : "ORC-2-Placer Order Number / ORC-3-Filler Order Number"
},
{
"identity" : "rim",
"map" : ".id"
}]
},
{
"id" : "MedicationRequest.status",
"path" : "MedicationRequest.status",
"short" : "active | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown",
"definition" : "A code specifying the current state of the order. Generally, this will be active or completed state.",
"comment" : "This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "MedicationRequest.status",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MedicationRequestStatus"
}],
"strength" : "required",
"description" : "A coded concept specifying the state of the prescribing event. Describes the lifecycle of the prescription.",
"valueSet" : "http://hl7.org/fhir/ValueSet/medicationrequest-status|4.0.1"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.status"
},
{
"identity" : "script10.6",
"map" : "no mapping"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
},
{
"identity" : "rim",
"map" : ".statusCode"
}]
},
{
"id" : "MedicationRequest.statusReason",
"path" : "MedicationRequest.statusReason",
"short" : "Reason for current status",
"definition" : "Captures the reason for the current state of the MedicationRequest.",
"comment" : "This is generally only used for \"exception\" statuses such as \"suspended\" or \"cancelled\". The reason why the MedicationRequest was created at all is captured in reasonCode, not here.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicationRequest.statusReason",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MedicationRequestStatusReason"
}],
"strength" : "example",
"description" : "Identifies the reasons for a given status.",
"valueSet" : "http://hl7.org/fhir/ValueSet/medicationrequest-status-reason"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.statusReason"
},
{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=SUBJ].source[classCode=CACT, moodCode=EVN].reasonCOde"
}]
},
{
"id" : "MedicationRequest.intent",
"path" : "MedicationRequest.intent",
"short" : "proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option",
"definition" : "Whether the request is a proposal, plan, or an original order.",
"comment" : "It is expected that the type of requester will be restricted for different stages of a MedicationRequest. For example, Proposals can be created by a patient, relatedPerson, Practitioner or Device. Plans can be created by Practitioners, Patients, RelatedPersons and Devices. Original orders can be created by a Practitioner only.\r\rAn instance-order is an instantiation of a request or order and may be used to populate Medication Administration Record.\r\rThis element is labeled as a modifier because the intent alters when and how the resource is actually applicable.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "MedicationRequest.intent",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element changes the interpretation of all descriptive attributes. For example \"the time the request is recommended to occur\" vs. \"the time the request is authorized to occur\" or \"who is recommended to perform the request\" vs. \"who is authorized to perform the request",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MedicationRequestIntent"
}],
"strength" : "required",
"description" : "The kind of medication order.",
"valueSet" : "http://hl7.org/fhir/ValueSet/medicationrequest-intent|4.0.1"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.intent"
},
{
"identity" : "w5",
"map" : "FiveWs.class"
},
{
"identity" : "rim",
"map" : ".moodCode (nuances beyond PRP/PLAN/RQO would need to be elsewhere)"
}]
},
{
"id" : "MedicationRequest.category",
"path" : "MedicationRequest.category",
"short" : "Type of medication usage",
"definition" : "Indicates the type of medication request (for example, where the medication is expected to be consumed or administered (i.e. inpatient or outpatient)).",
"comment" : "The category can be used to include where the medication is expected to be consumed or other types of requests.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicationRequest.category",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MedicationRequestCategory"
}],
"strength" : "example",
"description" : "A coded concept identifying the category of medication request. For example, where the medication is to be consumed or administered, or the type of medication treatment.",
"valueSet" : "http://hl7.org/fhir/ValueSet/medicationrequest-category"
},
"mapping" : [{
"identity" : "script10.6",
"map" : "Message/Body/NewRx/MedicationPrescribed/Directions\r\ror \r\rMessage/Body/NewRx/MedicationPrescribed/StructuredSIG"
},
{
"identity" : "w5",
"map" : "FiveWs.class"
},
{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=COMP].source[classCode=OBS, moodCode=EVN, code=\"type of medication usage\"].value"
}]
},
{
"id" : "MedicationRequest.priority",
"path" : "MedicationRequest.priority",
"short" : "routine | urgent | asap | stat",
"definition" : "Indicates how quickly the Medication Request should be addressed with respect to other requests.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicationRequest.priority",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MedicationRequestPriority"
}],
"strength" : "required",
"description" : "Identifies the level of importance to be assigned to actioning the request.",
"valueSet" : "http://hl7.org/fhir/ValueSet/request-priority|4.0.1"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.priority"
},
{
"identity" : "w5",
"map" : "FiveWs.grade"
},
{
"identity" : "rim",
"map" : ".priorityCode"
}]
},
{
"id" : "MedicationRequest.doNotPerform",
"path" : "MedicationRequest.doNotPerform",
"short" : "True if request is prohibiting action",
"definition" : "If true indicates that the provider is asking for the medication request not to occur.",
"comment" : "If do not perform is not specified, the request is a positive request e.g. \"do perform\".",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicationRequest.doNotPerform",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because this element negates the request to occur (ie, this is a request for the medication not to be ordered or prescribed, etc)",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "SubstanceAdministration.actionNegationInd"
}]
},
{
"id" : "MedicationRequest.reported[x]",
"path" : "MedicationRequest.reported[x]",
"short" : "Reported rather than primary record",
"definition" : "Indicates if this record was captured as a secondary 'reported' record rather than as an original primary source-of-truth record. It may also indicate the source of the report.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicationRequest.reported[x]",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
},
{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson",
"http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : ".participation[typeCode=INF].role"
}]
},
{
"id" : "MedicationRequest.medication[x]",
"path" : "MedicationRequest.medication[x]",
"short" : "Medication to be taken",
"definition" : "Identifies the medication being requested. This is a link to a resource that represents the medication which may be the details of the medication or simply an attribute carrying a code that identifies the medication from a known list of medications.",
"comment" : "If only a code is specified, then it needs to be a code for a specific product. If more information is required, then the use of the Medication resource is recommended. For example, if you require form or lot number or if the medication is compounded or extemporaneously prepared, then you must reference the Medication resource.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "MedicationRequest.medication[x]",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
},
{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Medication"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MedicationCode"
}],
"strength" : "example",
"description" : "A coded concept identifying substance or product that can be ordered.",
"valueSet" : "http://hl7.org/fhir/ValueSet/medication-codes"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.code"
},
{
"identity" : "script10.6",
"map" : "Message/Body/NewRx/MedicationPrescribed\r\rMedication.code.coding.code = Message/Body/NewRx/MedicationPrescribed/DrugCoded/ProductCode\r\rMedication.code.coding.system = Message/Body/NewRx/MedicationPrescribed/DrugCoded/ProductCodeQualifier\r\rMedication.code.coding.display = Message/Body/NewRx/MedicationPrescribed/DrugDescription"
},
{
"identity" : "w5",
"map" : "FiveWs.what[x]"
},
{
"identity" : "v2",
"map" : "RXE-2-Give Code / RXO-1-Requested Give Code / RXC-2-Component Code"
},
{
"identity" : "rim",
"map" : "consumable.administrableMedication"
}]
},
{
"id" : "MedicationRequest.subject",
"path" : "MedicationRequest.subject",
"short" : "Who or group medication request is for",
"definition" : "A link to a resource representing the person or set of individuals to whom the medication will be given.",
"comment" : "The subject on a medication request is mandatory. For the secondary use case where the actual subject is not provided, there still must be an anonymized subject specified.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "MedicationRequest.subject",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Group"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.subject"
},
{
"identity" : "script10.6",
"map" : "Message/Body/NewRx/Patient\r\r(need detail to link to specific patient … Patient.Identification in SCRIPT)"
},
{
"identity" : "w5",
"map" : "FiveWs.subject[x]"
},
{
"identity" : "v2",
"map" : "PID-3-Patient ID List"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=AUT].role"
},
{
"identity" : "w5",
"map" : "FiveWs.subject"
}]
},
{
"id" : "MedicationRequest.encounter",
"path" : "MedicationRequest.encounter",
"short" : "Encounter created as part of encounter/admission/stay",
"definition" : "The Encounter during which this [x] was created or to which the creation of this record is tightly associated.",
"comment" : "This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter.\" If there is a need to link to episodes of care they will be handled with an extension.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicationRequest.encounter",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Encounter"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.context"
},
{
"identity" : "script10.6",
"map" : "no mapping"
},
{
"identity" : "w5",
"map" : "FiveWs.context"
},
{
"identity" : "v2",
"map" : "PV1-19-Visit Number"
},
{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN, code=\"type of encounter or episode\"]"
}]
},
{
"id" : "MedicationRequest.supportingInformation",
"path" : "MedicationRequest.supportingInformation",
"short" : "Information to support ordering of the medication",
"definition" : "Include additional information (for example, patient height and weight) that supports the ordering of the medication.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicationRequest.supportingInformation",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.supportingInfo"
},
{
"identity" : "w5",
"map" : "FiveWs.context"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=PERT].target[A_SupportingClinicalStatement CMET minimal with many different choices of classCodes(ORG, ENC, PROC, SPLY, SBADM, OBS) and each of the act class codes draws from one or more of the following moodCodes (EVN, DEF, INT PRMS, RQO, PRP, APT, ARQ, GOL)]"
}]
},
{
"id" : "MedicationRequest.authoredOn",
"path" : "MedicationRequest.authoredOn",
"short" : "When request was initially authored",
"definition" : "The date (and perhaps time) when the prescription was initially written or authored on.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicationRequest.authoredOn",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.authoredOn"
},
{
"identity" : "script10.6",
"map" : "Message/Body/NewRx/MedicationPrescribed/WrittenDate"
},
{
"identity" : "w5",
"map" : "FiveWs.recorded"
},
{
"identity" : "v2",
"map" : "RXE-32-Original Order Date/Time / ORC-9-Date/Time of Transaction"
},
{
"identity" : "rim",
"map" : "author.time"
}]
},
{
"id" : "MedicationRequest.requester",
"path" : "MedicationRequest.requester",
"short" : "Who/What requested the Request",
"definition" : "The individual, organization, or device that initiated the request and has responsibility for its activation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicationRequest.requester",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Organization",
"http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson",
"http://hl7.org/fhir/StructureDefinition/Device"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.requester"
},
{
"identity" : "w5",
"map" : "FiveWs.author"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=AUT].role"
}]
},
{
"id" : "MedicationRequest.performer",
"path" : "MedicationRequest.performer",
"short" : "Intended performer of administration",
"definition" : "The specified desired performer of the medication treatment (e.g. the performer of the medication administration).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicationRequest.performer",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Organization",
"http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Device",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson",
"http://hl7.org/fhir/StructureDefinition/CareTeam"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.performer"
},
{
"identity" : "w5",
"map" : "FiveWs.actor"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]"
}]
},
{
"id" : "MedicationRequest.performerType",
"path" : "MedicationRequest.performerType",
"short" : "Desired kind of performer of the medication administration",
"definition" : "Indicates the type of performer of the administration of the medication.",
"comment" : "If specified without indicating a performer, this indicates that the performer must be of the specified type. If specified with a performer then it indicates the requirements of the performer if the designated performer is not available.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicationRequest.performerType",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MedicationRequestPerformerType"
}],
"strength" : "example",
"description" : "Identifies the type of individual that is desired to administer the medication.",
"valueSet" : "http://hl7.org/fhir/ValueSet/performer-role"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.performerType"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=PRF].role[scoper.determinerCode=KIND].code"
}]
},
{
"id" : "MedicationRequest.recorder",
"path" : "MedicationRequest.recorder",
"short" : "Person who entered the request",
"definition" : "The person who entered the order on behalf of another individual for example in the case of a verbal or a telephone order.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicationRequest.recorder",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.who"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=TRANS].role[classCode=ASSIGNED].code (HealthcareProviderType)"
}]
},
{
"id" : "MedicationRequest.reasonCode",
"path" : "MedicationRequest.reasonCode",
"short" : "Reason or indication for ordering or not ordering the medication",
"definition" : "The reason or the indication for ordering or not ordering the medication.",
"comment" : "This could be a diagnosis code. If a full condition record exists or additional detail is needed, use reasonReference.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicationRequest.reasonCode",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MedicationRequestReason"
}],
"strength" : "example",
"description" : "A coded concept indicating why the medication was ordered.",
"valueSet" : "http://hl7.org/fhir/ValueSet/condition-code"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.reasonCode"
},
{
"identity" : "script10.6",
"map" : "Message/Body/NewRx/MedicationPrescribed/Diagnosis/Primary/Value"
},
{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "v2",
"map" : "ORC-16-Order Control Code Reason /RXE-27-Give Indication/RXO-20-Indication / RXD-21-Indication / RXG-22-Indication / RXA-19-Indication"
},
{
"identity" : "rim",
"map" : "reason.observation.reasonCode"
}]
},
{
"id" : "MedicationRequest.reasonReference",
"path" : "MedicationRequest.reasonReference",
"short" : "Condition or observation that supports why the prescription is being written",
"definition" : "Condition or observation that supports why the medication was ordered.",
"comment" : "This is a reference to a condition or observation that is the reason for the medication order. If only a code exists, use reasonCode.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicationRequest.reasonReference",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Condition",
"http://hl7.org/fhir/StructureDefinition/Observation"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.reasonReference"
},
{
"identity" : "script10.6",
"map" : "no mapping"
},
{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "rim",
"map" : "reason.observation[code=ASSERTION].value"
}]
},
{
"id" : "MedicationRequest.instantiatesCanonical",
"path" : "MedicationRequest.instantiatesCanonical",
"short" : "Instantiates FHIR protocol or definition",
"definition" : "The URL pointing to a protocol, guideline, orderset, or other definition that is adhered to in whole or in part by this MedicationRequest.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicationRequest.instantiatesCanonical",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "canonical"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.instantiates"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=DEFN].target"
}]
},
{
"id" : "MedicationRequest.instantiatesUri",
"path" : "MedicationRequest.instantiatesUri",
"short" : "Instantiates external protocol or definition",
"definition" : "The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this MedicationRequest.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicationRequest.instantiatesUri",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=DEFN].target"
}]
},
{
"id" : "MedicationRequest.basedOn",
"path" : "MedicationRequest.basedOn",
"short" : "What request fulfills",
"definition" : "A plan or request that is fulfilled in whole or in part by this medication request.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicationRequest.basedOn",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/CarePlan",
"http://hl7.org/fhir/StructureDefinition/MedicationRequest",
"http://hl7.org/fhir/StructureDefinition/ServiceRequest",
"http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.basedOn"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=FLFS].target[classCode=SBADM or PROC or PCPR or OBS, moodCode=RQO orPLAN or PRP]"
}]
},
{
"id" : "MedicationRequest.groupIdentifier",
"path" : "MedicationRequest.groupIdentifier",
"short" : "Composite request this is part of",
"definition" : "A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition or prescription.",
"requirements" : "Requests are linked either by a \"basedOn\" relationship (i.e. one request is fulfilling another) or by having a common requisition. Requests that are part of the same requisition are generally treated independently from the perspective of changing their state or maintaining them after initial creation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicationRequest.groupIdentifier",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Identifier"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.groupIdentifier"
},
{
"identity" : "rim",
"map" : ".outboundRelationship(typeCode=COMP].target[classCode=SBADM, moodCode=INT].id"
}]
},
{
"id" : "MedicationRequest.courseOfTherapyType",
"path" : "MedicationRequest.courseOfTherapyType",
"short" : "Overall pattern of medication administration",
"definition" : "The description of the overall patte3rn of the administration of the medication to the patient.",
"comment" : "This attribute should not be confused with the protocol of the medication.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicationRequest.courseOfTherapyType",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MedicationRequestCourseOfTherapy"
}],
"strength" : "example",
"description" : "Identifies the overall pattern of medication administratio.",
"valueSet" : "http://hl7.org/fhir/ValueSet/medicationrequest-course-of-therapy"
},
"mapping" : [{
"identity" : "rim",
"map" : "Act.code where classCode = LIST and moodCode = EVN"
}]
},
{
"id" : "MedicationRequest.insurance",
"path" : "MedicationRequest.insurance",
"short" : "Associated insurance coverage",
"definition" : "Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be required for delivering the requested service.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicationRequest.insurance",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Coverage",
"http://hl7.org/fhir/StructureDefinition/ClaimResponse"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.insurance"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=COVBY].target"
}]
},
{
"id" : "MedicationRequest.note",
"path" : "MedicationRequest.note",
"short" : "Information about the prescription",
"definition" : "Extra information about the prescription that could not be conveyed by the other attributes.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicationRequest.note",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Annotation"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.note"
},
{
"identity" : "script10.6",
"map" : "Message/Body/NewRx/MedicationPrescribed/Note"
},
{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=SUBJ]/source[classCode=OBS,moodCode=EVN,code=\"annotation\"].value"
}]
},
{
"id" : "MedicationRequest.dosageInstruction",
"path" : "MedicationRequest.dosageInstruction",
"short" : "How the medication should be taken",
"definition" : "Indicates how the medication is to be used by the patient.",
"comment" : "There are examples where a medication request may include the option of an oral dose or an Intravenous or Intramuscular dose. For example, \"Ondansetron 8mg orally or IV twice a day as needed for nausea\" or \"Compazine® (prochlorperazine) 5-10mg PO or 25mg PR bid prn nausea or vomiting\". In these cases, two medication requests would be created that could be grouped together. The decision on which dose and route of administration to use is based on the patient's condition at the time the dose is needed.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicationRequest.dosageInstruction",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Dosage"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.occurrence[x]"
},
{
"identity" : "rim",
"map" : "see dosageInstruction mapping"
}]
},
{
"id" : "MedicationRequest.dispenseRequest",
"path" : "MedicationRequest.dispenseRequest",
"short" : "Medication supply authorization",
"definition" : "Indicates the specific details for the dispense or medication supply part of a medication request (also known as a Medication Prescription or Medication Order). Note that this information is not always sent with the order. There may be in some settings (e.g. hospitals) institutional or system support for completing the dispense details in the pharmacy department.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicationRequest.dispenseRequest",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "script10.6",
"map" : "Message/Body/NewRx/MedicationPrescribed/ExpirationDate"
},
{
"identity" : "rim",
"map" : "component.supplyEvent"
}]
},
{
"id" : "MedicationRequest.dispenseRequest.id",
"path" : "MedicationRequest.dispenseRequest.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MedicationRequest.dispenseRequest.extension",
"path" : "MedicationRequest.dispenseRequest.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MedicationRequest.dispenseRequest.modifierExtension",
"path" : "MedicationRequest.dispenseRequest.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MedicationRequest.dispenseRequest.initialFill",
"path" : "MedicationRequest.dispenseRequest.initialFill",
"short" : "First fill details",
"definition" : "Indicates the quantity or duration for the first dispense of the medication.",
"comment" : "If populating this element, either the quantity or the duration must be included.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicationRequest.dispenseRequest.initialFill",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "SubstanceAdministration -> ActRelationship[sequenceNumber = '1'] -> Supply"
}]
},
{
"id" : "MedicationRequest.dispenseRequest.initialFill.id",
"path" : "MedicationRequest.dispenseRequest.initialFill.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MedicationRequest.dispenseRequest.initialFill.extension",
"path" : "MedicationRequest.dispenseRequest.initialFill.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MedicationRequest.dispenseRequest.initialFill.modifierExtension",
"path" : "MedicationRequest.dispenseRequest.initialFill.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MedicationRequest.dispenseRequest.initialFill.quantity",
"path" : "MedicationRequest.dispenseRequest.initialFill.quantity",
"short" : "First fill quantity",
"definition" : "The amount or quantity to provide as part of the first dispense.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicationRequest.dispenseRequest.initialFill.quantity",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Quantity",
"profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Supply.quantity[moodCode=RQO]"
}]
},
{
"id" : "MedicationRequest.dispenseRequest.initialFill.duration",
"path" : "MedicationRequest.dispenseRequest.initialFill.duration",
"short" : "First fill duration",
"definition" : "The length of time that the first dispense is expected to last.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicationRequest.dispenseRequest.initialFill.duration",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Duration"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Supply.effectivetime[moodCode=RQO]"
}]
},
{
"id" : "MedicationRequest.dispenseRequest.dispenseInterval",
"path" : "MedicationRequest.dispenseRequest.dispenseInterval",
"short" : "Minimum period of time between dispenses",
"definition" : "The minimum period of time that must occur between dispenses of the medication.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicationRequest.dispenseRequest.dispenseInterval",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Duration"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Supply.effectivetime[moodCode=RQO]"
}]
},
{
"id" : "MedicationRequest.dispenseRequest.validityPeriod",
"path" : "MedicationRequest.dispenseRequest.validityPeriod",
"short" : "Time period supply is authorized for",
"definition" : "This indicates the validity period of a prescription (stale dating the Prescription).",
"comment" : "It reflects the prescribers' perspective for the validity of the prescription. Dispenses must not be made against the prescription outside of this period. The lower-bound of the Dispensing Window signifies the earliest date that the prescription can be filled for the first time. If an upper-bound is not specified then the Prescription is open-ended or will default to a stale-date based on regulations.",
"requirements" : "Indicates when the Prescription becomes valid, and when it ceases to be a dispensable Prescription.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicationRequest.dispenseRequest.validityPeriod",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Period"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "script10.6",
"map" : "Message/Body/NewRx/MedicationPrescribed/Refills"
},
{
"identity" : "rim",
"map" : "effectiveTime"
}]
},
{
"id" : "MedicationRequest.dispenseRequest.numberOfRepeatsAllowed",
"path" : "MedicationRequest.dispenseRequest.numberOfRepeatsAllowed",
"short" : "Number of refills authorized",
"definition" : "An integer indicating the number of times, in addition to the original dispense, (aka refills or repeats) that the patient can receive the prescribed medication. Usage Notes: This integer does not include the original order dispense. This means that if an order indicates dispense 30 tablets plus \"3 repeats\", then the order can be dispensed a total of 4 times and the patient can receive a total of 120 tablets. A prescriber may explicitly say that zero refills are permitted after the initial dispense.",
"comment" : "If displaying \"number of authorized fills\", add 1 to this number.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicationRequest.dispenseRequest.numberOfRepeatsAllowed",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "unsignedInt"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "script10.6",
"map" : "Message/Body/NewRx/MedicationPrescribed/Quantity"
},
{
"identity" : "v2",
"map" : "RXE-12-Number of Refills"
},
{
"identity" : "rim",
"map" : "repeatNumber"
}]
},
{
"id" : "MedicationRequest.dispenseRequest.quantity",
"path" : "MedicationRequest.dispenseRequest.quantity",
"short" : "Amount of medication to supply per dispense",
"definition" : "The amount that is to be dispensed for one fill.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicationRequest.dispenseRequest.quantity",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Quantity",
"profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "script10.6",
"map" : "Message/Body/NewRx/MedicationPrescribed/DaysSupply"
},
{
"identity" : "v2",
"map" : "RXD-4-Actual Dispense Amount / RXD-5.1-Actual Dispense Units.code / RXD-5.3-Actual Dispense Units.name of coding system"
},
{
"identity" : "rim",
"map" : "quantity"
}]
},
{
"id" : "MedicationRequest.dispenseRequest.expectedSupplyDuration",
"path" : "MedicationRequest.dispenseRequest.expectedSupplyDuration",
"short" : "Number of days supply per dispense",
"definition" : "Identifies the period time over which the supplied product is expected to be used, or the length of time the dispense is expected to last.",
"comment" : "In some situations, this attribute may be used instead of quantity to identify the amount supplied by how long it is expected to last, rather than the physical quantity issued, e.g. 90 days supply of medication (based on an ordered dosage). When possible, it is always better to specify quantity, as this tends to be more precise. expectedSupplyDuration will always be an estimate that can be influenced by external factors.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicationRequest.dispenseRequest.expectedSupplyDuration",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Duration"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "script10.6",
"map" : "Message/Body/NewRx/MedicationPrescribed/Substitutions"
},
{
"identity" : "rim",
"map" : "expectedUseTime"
}]
},
{
"id" : "MedicationRequest.dispenseRequest.performer",
"path" : "MedicationRequest.dispenseRequest.performer",
"short" : "Intended dispenser",
"definition" : "Indicates the intended dispensing Organization specified by the prescriber.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicationRequest.dispenseRequest.performer",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.who"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=COMP].target[classCode=SPLY, moodCode=RQO] .participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]"
}]
},
{
"id" : "MedicationRequest.substitution",
"path" : "MedicationRequest.substitution",
"short" : "Any restrictions on medication substitution",
"definition" : "Indicates whether or not substitution can or should be part of the dispense. In some cases, substitution must happen, in other cases substitution must not happen. This block explains the prescriber's intent. If nothing is specified substitution may be done.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicationRequest.substitution",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "script10.6",
"map" : "specific values within Message/Body/NewRx/MedicationPrescribed/Substitutions"
},
{
"identity" : "rim",
"map" : "subjectOf.substitutionPersmission"
}]
},
{
"id" : "MedicationRequest.substitution.id",
"path" : "MedicationRequest.substitution.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MedicationRequest.substitution.extension",
"path" : "MedicationRequest.substitution.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MedicationRequest.substitution.modifierExtension",
"path" : "MedicationRequest.substitution.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MedicationRequest.substitution.allowed[x]",
"path" : "MedicationRequest.substitution.allowed[x]",
"short" : "Whether substitution is allowed or not",
"definition" : "True if the prescriber allows a different drug to be dispensed from what was prescribed.",
"comment" : "This element is labeled as a modifier because whether substitution is allow or not, it cannot be ignored.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "MedicationRequest.substitution.allowed[x]",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "boolean"
},
{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MedicationRequestSubstitution"
}],
"strength" : "example",
"description" : "Identifies the type of substitution allowed.",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-ActSubstanceAdminSubstitutionCode"
},
"mapping" : [{
"identity" : "script10.6",
"map" : "specific values within Message/Body/NewRx/MedicationPrescribed/Substitutions"
},
{
"identity" : "v2",
"map" : "RXO-9-Allow Substitutions / RXE-9-Substitution Status"
},
{
"identity" : "rim",
"map" : "code"
}]
},
{
"id" : "MedicationRequest.substitution.reason",
"path" : "MedicationRequest.substitution.reason",
"short" : "Why should (not) substitution be made",
"definition" : "Indicates the reason for the substitution, or why substitution must or must not be performed.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicationRequest.substitution.reason",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MedicationIntendedSubstitutionReason"
}],
"strength" : "example",
"description" : "A coded concept describing the reason that a different medication should (or should not) be substituted from what was prescribed.",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-SubstanceAdminSubstitutionReason"
},
"mapping" : [{
"identity" : "script10.6",
"map" : "not mapped"
},
{
"identity" : "v2",
"map" : "RXE-9 Substition status"
},
{
"identity" : "rim",
"map" : "reasonCode"
}]
},
{
"id" : "MedicationRequest.priorPrescription",
"path" : "MedicationRequest.priorPrescription",
"short" : "An order/prescription that is being replaced",
"definition" : "A link to a resource representing an earlier order related order or prescription.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicationRequest.priorPrescription",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/MedicationRequest"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.replaces"
},
{
"identity" : "script10.6",
"map" : "not mapped"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=?RPLC or ?SUCC]/target[classCode=SBADM,moodCode=RQO]"
}]
},
{
"id" : "MedicationRequest.detectedIssue",
"path" : "MedicationRequest.detectedIssue",
"short" : "Clinical Issue with action",
"definition" : "Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. Drug-drug interaction, duplicate therapy, dosage alert etc.",
"comment" : "This element can include a detected issue that has been identified either by a decision support system or by a clinician and may include information on the steps that were taken to address the issue.",
"alias" : ["Contraindication",
"Drug Utilization Review (DUR)",
"Alert"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicationRequest.detectedIssue",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/DetectedIssue"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=SUBJ]/source[classCode=ALRT,moodCode=EVN].value"
}]
},
{
"id" : "MedicationRequest.eventHistory",
"path" : "MedicationRequest.eventHistory",
"short" : "A list of events of interest in the lifecycle",
"definition" : "Links to Provenance records for past versions of this resource or fulfilling request or event resources that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the resource.",
"comment" : "This might not include provenances for all versions of the request – only those deemed “relevant” or important. This SHALL NOT include the provenance associated with this current version of the resource. (If that provenance is deemed to be a “relevant” change, it will need to be added as part of a later update. Until then, it can be queried directly as the provenance that points to this version using _revinclude All Provenances should have some historical version of this Request as their subject.).",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicationRequest.eventHistory",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Provenance"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.relevantHistory"
},
{
"identity" : "rim",
"map" : ".inboundRelationship(typeCode=SUBJ].source[classCode=CACT, moodCode=EVN]"
}]
}]
},
"differential" : {
"element" : [{
"id" : "MedicationRequest",
"path" : "MedicationRequest",
"short" : "Ordering of medication for patient or group",
"definition" : "An order or request for both supply of the medication and the instructions for administration of the medication to a patient. The resource is called \"MedicationRequest\" rather than \"MedicationPrescription\" or \"MedicationOrder\" to generalize the use across inpatient and outpatient settings, including care plans, etc., and to harmonize with workflow patterns.",
"alias" : ["Prescription",
"Order"],
"min" : 0,
"max" : "*",
"mapping" : [{
"identity" : "workflow",
"map" : "Request"
},
{
"identity" : "script10.6",
"map" : "Message/Body/NewRx"
},
{
"identity" : "rim",
"map" : "CombinedMedicationRequest"
}]
},
{
"id" : "MedicationRequest.identifier",
"path" : "MedicationRequest.identifier",
"short" : "External ids for this request",
"definition" : "Identifiers associated with this medication request that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server.",
"comment" : "This is a business identifier, not a resource identifier.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Identifier"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Request.identifier"
},
{
"identity" : "script10.6",
"map" : "Message/Header/PrescriberOrderNumber"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "v2",
"map" : "ORC-2-Placer Order Number / ORC-3-Filler Order Number"
},
{
"identity" : "rim",
"map" : ".id"
}]
},
{
"id" : "MedicationRequest.status",
"path" : "MedicationRequest.status",
"short" : "active | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown",
"definition" : "A code specifying the current state of the order. Generally, this will be active or completed state.",
"comment" : "This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MedicationRequestStatus"
}],
"strength" : "required",
"description" : "A coded concept specifying the state of the prescribing event. Describes the lifecycle of the prescription.",
"valueSet" : "http://hl7.org/fhir/ValueSet/medicationrequest-status|4.0.1"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.status"
},
{
"identity" : "script10.6",
"map" : "no mapping"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
},
{
"identity" : "rim",
"map" : ".statusCode"
}]
},
{
"id" : "MedicationRequest.statusReason",
"path" : "MedicationRequest.statusReason",
"short" : "Reason for current status",
"definition" : "Captures the reason for the current state of the MedicationRequest.",
"comment" : "This is generally only used for \"exception\" statuses such as \"suspended\" or \"cancelled\". The reason why the MedicationRequest was created at all is captured in reasonCode, not here.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MedicationRequestStatusReason"
}],
"strength" : "example",
"description" : "Identifies the reasons for a given status.",
"valueSet" : "http://hl7.org/fhir/ValueSet/medicationrequest-status-reason"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.statusReason"
},
{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=SUBJ].source[classCode=CACT, moodCode=EVN].reasonCOde"
}]
},
{
"id" : "MedicationRequest.intent",
"path" : "MedicationRequest.intent",
"short" : "proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option",
"definition" : "Whether the request is a proposal, plan, or an original order.",
"comment" : "It is expected that the type of requester will be restricted for different stages of a MedicationRequest. For example, Proposals can be created by a patient, relatedPerson, Practitioner or Device. Plans can be created by Practitioners, Patients, RelatedPersons and Devices. Original orders can be created by a Practitioner only.\r\rAn instance-order is an instantiation of a request or order and may be used to populate Medication Administration Record.\r\rThis element is labeled as a modifier because the intent alters when and how the resource is actually applicable.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isModifier" : true,
"isModifierReason" : "This element changes the interpretation of all descriptive attributes. For example \"the time the request is recommended to occur\" vs. \"the time the request is authorized to occur\" or \"who is recommended to perform the request\" vs. \"who is authorized to perform the request",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MedicationRequestIntent"
}],
"strength" : "required",
"description" : "The kind of medication order.",
"valueSet" : "http://hl7.org/fhir/ValueSet/medicationrequest-intent|4.0.1"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.intent"
},
{
"identity" : "w5",
"map" : "FiveWs.class"
},
{
"identity" : "rim",
"map" : ".moodCode (nuances beyond PRP/PLAN/RQO would need to be elsewhere)"
}]
},
{
"id" : "MedicationRequest.category",
"path" : "MedicationRequest.category",
"short" : "Type of medication usage",
"definition" : "Indicates the type of medication request (for example, where the medication is expected to be consumed or administered (i.e. inpatient or outpatient)).",
"comment" : "The category can be used to include where the medication is expected to be consumed or other types of requests.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MedicationRequestCategory"
}],
"strength" : "example",
"description" : "A coded concept identifying the category of medication request. For example, where the medication is to be consumed or administered, or the type of medication treatment.",
"valueSet" : "http://hl7.org/fhir/ValueSet/medicationrequest-category"
},
"mapping" : [{
"identity" : "script10.6",
"map" : "Message/Body/NewRx/MedicationPrescribed/Directions\r\ror \r\rMessage/Body/NewRx/MedicationPrescribed/StructuredSIG"
},
{
"identity" : "w5",
"map" : "FiveWs.class"
},
{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=COMP].source[classCode=OBS, moodCode=EVN, code=\"type of medication usage\"].value"
}]
},
{
"id" : "MedicationRequest.priority",
"path" : "MedicationRequest.priority",
"short" : "routine | urgent | asap | stat",
"definition" : "Indicates how quickly the Medication Request should be addressed with respect to other requests.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MedicationRequestPriority"
}],
"strength" : "required",
"description" : "Identifies the level of importance to be assigned to actioning the request.",
"valueSet" : "http://hl7.org/fhir/ValueSet/request-priority|4.0.1"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.priority"
},
{
"identity" : "w5",
"map" : "FiveWs.grade"
},
{
"identity" : "rim",
"map" : ".priorityCode"
}]
},
{
"id" : "MedicationRequest.doNotPerform",
"path" : "MedicationRequest.doNotPerform",
"short" : "True if request is prohibiting action",
"definition" : "If true indicates that the provider is asking for the medication request not to occur.",
"comment" : "If do not perform is not specified, the request is a positive request e.g. \"do perform\".",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "boolean"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because this element negates the request to occur (ie, this is a request for the medication not to be ordered or prescribed, etc)",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "SubstanceAdministration.actionNegationInd"
}]
},
{
"id" : "MedicationRequest.reported[x]",
"path" : "MedicationRequest.reported[x]",
"short" : "Reported rather than primary record",
"definition" : "Indicates if this record was captured as a secondary 'reported' record rather than as an original primary source-of-truth record. It may also indicate the source of the report.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "boolean"
},
{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson",
"http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : ".participation[typeCode=INF].role"
}]
},
{
"id" : "MedicationRequest.medication[x]",
"path" : "MedicationRequest.medication[x]",
"short" : "Medication to be taken",
"definition" : "Identifies the medication being requested. This is a link to a resource that represents the medication which may be the details of the medication or simply an attribute carrying a code that identifies the medication from a known list of medications.",
"comment" : "If only a code is specified, then it needs to be a code for a specific product. If more information is required, then the use of the Medication resource is recommended. For example, if you require form or lot number or if the medication is compounded or extemporaneously prepared, then you must reference the Medication resource.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
},
{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Medication"]
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MedicationCode"
}],
"strength" : "example",
"description" : "A coded concept identifying substance or product that can be ordered.",
"valueSet" : "http://hl7.org/fhir/ValueSet/medication-codes"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.code"
},
{
"identity" : "script10.6",
"map" : "Message/Body/NewRx/MedicationPrescribed\r\rMedication.code.coding.code = Message/Body/NewRx/MedicationPrescribed/DrugCoded/ProductCode\r\rMedication.code.coding.system = Message/Body/NewRx/MedicationPrescribed/DrugCoded/ProductCodeQualifier\r\rMedication.code.coding.display = Message/Body/NewRx/MedicationPrescribed/DrugDescription"
},
{
"identity" : "w5",
"map" : "FiveWs.what[x]"
},
{
"identity" : "v2",
"map" : "RXE-2-Give Code / RXO-1-Requested Give Code / RXC-2-Component Code"
},
{
"identity" : "rim",
"map" : "consumable.administrableMedication"
}]
},
{
"id" : "MedicationRequest.subject",
"path" : "MedicationRequest.subject",
"short" : "Who or group medication request is for",
"definition" : "A link to a resource representing the person or set of individuals to whom the medication will be given.",
"comment" : "The subject on a medication request is mandatory. For the secondary use case where the actual subject is not provided, there still must be an anonymized subject specified.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Group"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.subject"
},
{
"identity" : "script10.6",
"map" : "Message/Body/NewRx/Patient\r\r(need detail to link to specific patient … Patient.Identification in SCRIPT)"
},
{
"identity" : "w5",
"map" : "FiveWs.subject[x]"
},
{
"identity" : "v2",
"map" : "PID-3-Patient ID List"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=AUT].role"
},
{
"identity" : "w5",
"map" : "FiveWs.subject"
}]
},
{
"id" : "MedicationRequest.encounter",
"path" : "MedicationRequest.encounter",
"short" : "Encounter created as part of encounter/admission/stay",
"definition" : "The Encounter during which this [x] was created or to which the creation of this record is tightly associated.",
"comment" : "This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter.\" If there is a need to link to episodes of care they will be handled with an extension.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Encounter"]
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Request.context"
},
{
"identity" : "script10.6",
"map" : "no mapping"
},
{
"identity" : "w5",
"map" : "FiveWs.context"
},
{
"identity" : "v2",
"map" : "PV1-19-Visit Number"
},
{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN, code=\"type of encounter or episode\"]"
}]
},
{
"id" : "MedicationRequest.supportingInformation",
"path" : "MedicationRequest.supportingInformation",
"short" : "Information to support ordering of the medication",
"definition" : "Include additional information (for example, patient height and weight) that supports the ordering of the medication.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Request.supportingInfo"
},
{
"identity" : "w5",
"map" : "FiveWs.context"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=PERT].target[A_SupportingClinicalStatement CMET minimal with many different choices of classCodes(ORG, ENC, PROC, SPLY, SBADM, OBS) and each of the act class codes draws from one or more of the following moodCodes (EVN, DEF, INT PRMS, RQO, PRP, APT, ARQ, GOL)]"
}]
},
{
"id" : "MedicationRequest.authoredOn",
"path" : "MedicationRequest.authoredOn",
"short" : "When request was initially authored",
"definition" : "The date (and perhaps time) when the prescription was initially written or authored on.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "dateTime"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.authoredOn"
},
{
"identity" : "script10.6",
"map" : "Message/Body/NewRx/MedicationPrescribed/WrittenDate"
},
{
"identity" : "w5",
"map" : "FiveWs.recorded"
},
{
"identity" : "v2",
"map" : "RXE-32-Original Order Date/Time / ORC-9-Date/Time of Transaction"
},
{
"identity" : "rim",
"map" : "author.time"
}]
},
{
"id" : "MedicationRequest.requester",
"path" : "MedicationRequest.requester",
"short" : "Who/What requested the Request",
"definition" : "The individual, organization, or device that initiated the request and has responsibility for its activation.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Organization",
"http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson",
"http://hl7.org/fhir/StructureDefinition/Device"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.requester"
},
{
"identity" : "w5",
"map" : "FiveWs.author"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=AUT].role"
}]
},
{
"id" : "MedicationRequest.performer",
"path" : "MedicationRequest.performer",
"short" : "Intended performer of administration",
"definition" : "The specified desired performer of the medication treatment (e.g. the performer of the medication administration).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Organization",
"http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Device",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson",
"http://hl7.org/fhir/StructureDefinition/CareTeam"]
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Request.performer"
},
{
"identity" : "w5",
"map" : "FiveWs.actor"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]"
}]
},
{
"id" : "MedicationRequest.performerType",
"path" : "MedicationRequest.performerType",
"short" : "Desired kind of performer of the medication administration",
"definition" : "Indicates the type of performer of the administration of the medication.",
"comment" : "If specified without indicating a performer, this indicates that the performer must be of the specified type. If specified with a performer then it indicates the requirements of the performer if the designated performer is not available.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MedicationRequestPerformerType"
}],
"strength" : "example",
"description" : "Identifies the type of individual that is desired to administer the medication.",
"valueSet" : "http://hl7.org/fhir/ValueSet/performer-role"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.performerType"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=PRF].role[scoper.determinerCode=KIND].code"
}]
},
{
"id" : "MedicationRequest.recorder",
"path" : "MedicationRequest.recorder",
"short" : "Person who entered the request",
"definition" : "The person who entered the order on behalf of another individual for example in the case of a verbal or a telephone order.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole"]
}],
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.who"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=TRANS].role[classCode=ASSIGNED].code (HealthcareProviderType)"
}]
},
{
"id" : "MedicationRequest.reasonCode",
"path" : "MedicationRequest.reasonCode",
"short" : "Reason or indication for ordering or not ordering the medication",
"definition" : "The reason or the indication for ordering or not ordering the medication.",
"comment" : "This could be a diagnosis code. If a full condition record exists or additional detail is needed, use reasonReference.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MedicationRequestReason"
}],
"strength" : "example",
"description" : "A coded concept indicating why the medication was ordered.",
"valueSet" : "http://hl7.org/fhir/ValueSet/condition-code"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.reasonCode"
},
{
"identity" : "script10.6",
"map" : "Message/Body/NewRx/MedicationPrescribed/Diagnosis/Primary/Value"
},
{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "v2",
"map" : "ORC-16-Order Control Code Reason /RXE-27-Give Indication/RXO-20-Indication / RXD-21-Indication / RXG-22-Indication / RXA-19-Indication"
},
{
"identity" : "rim",
"map" : "reason.observation.reasonCode"
}]
},
{
"id" : "MedicationRequest.reasonReference",
"path" : "MedicationRequest.reasonReference",
"short" : "Condition or observation that supports why the prescription is being written",
"definition" : "Condition or observation that supports why the medication was ordered.",
"comment" : "This is a reference to a condition or observation that is the reason for the medication order. If only a code exists, use reasonCode.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Condition",
"http://hl7.org/fhir/StructureDefinition/Observation"]
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Request.reasonReference"
},
{
"identity" : "script10.6",
"map" : "no mapping"
},
{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "rim",
"map" : "reason.observation[code=ASSERTION].value"
}]
},
{
"id" : "MedicationRequest.instantiatesCanonical",
"path" : "MedicationRequest.instantiatesCanonical",
"short" : "Instantiates FHIR protocol or definition",
"definition" : "The URL pointing to a protocol, guideline, orderset, or other definition that is adhered to in whole or in part by this MedicationRequest.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "canonical"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.instantiates"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=DEFN].target"
}]
},
{
"id" : "MedicationRequest.instantiatesUri",
"path" : "MedicationRequest.instantiatesUri",
"short" : "Instantiates external protocol or definition",
"definition" : "The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this MedicationRequest.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "uri"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=DEFN].target"
}]
},
{
"id" : "MedicationRequest.basedOn",
"path" : "MedicationRequest.basedOn",
"short" : "What request fulfills",
"definition" : "A plan or request that is fulfilled in whole or in part by this medication request.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/CarePlan",
"http://hl7.org/fhir/StructureDefinition/MedicationRequest",
"http://hl7.org/fhir/StructureDefinition/ServiceRequest",
"http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.basedOn"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=FLFS].target[classCode=SBADM or PROC or PCPR or OBS, moodCode=RQO orPLAN or PRP]"
}]
},
{
"id" : "MedicationRequest.groupIdentifier",
"path" : "MedicationRequest.groupIdentifier",
"short" : "Composite request this is part of",
"definition" : "A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition or prescription.",
"requirements" : "Requests are linked either by a \"basedOn\" relationship (i.e. one request is fulfilling another) or by having a common requisition. Requests that are part of the same requisition are generally treated independently from the perspective of changing their state or maintaining them after initial creation.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Identifier"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.groupIdentifier"
},
{
"identity" : "rim",
"map" : ".outboundRelationship(typeCode=COMP].target[classCode=SBADM, moodCode=INT].id"
}]
},
{
"id" : "MedicationRequest.courseOfTherapyType",
"path" : "MedicationRequest.courseOfTherapyType",
"short" : "Overall pattern of medication administration",
"definition" : "The description of the overall patte3rn of the administration of the medication to the patient.",
"comment" : "This attribute should not be confused with the protocol of the medication.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MedicationRequestCourseOfTherapy"
}],
"strength" : "example",
"description" : "Identifies the overall pattern of medication administratio.",
"valueSet" : "http://hl7.org/fhir/ValueSet/medicationrequest-course-of-therapy"
},
"mapping" : [{
"identity" : "rim",
"map" : "Act.code where classCode = LIST and moodCode = EVN"
}]
},
{
"id" : "MedicationRequest.insurance",
"path" : "MedicationRequest.insurance",
"short" : "Associated insurance coverage",
"definition" : "Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be required for delivering the requested service.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Coverage",
"http://hl7.org/fhir/StructureDefinition/ClaimResponse"]
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Request.insurance"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=COVBY].target"
}]
},
{
"id" : "MedicationRequest.note",
"path" : "MedicationRequest.note",
"short" : "Information about the prescription",
"definition" : "Extra information about the prescription that could not be conveyed by the other attributes.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Annotation"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Request.note"
},
{
"identity" : "script10.6",
"map" : "Message/Body/NewRx/MedicationPrescribed/Note"
},
{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=SUBJ]/source[classCode=OBS,moodCode=EVN,code=\"annotation\"].value"
}]
},
{
"id" : "MedicationRequest.dosageInstruction",
"path" : "MedicationRequest.dosageInstruction",
"short" : "How the medication should be taken",
"definition" : "Indicates how the medication is to be used by the patient.",
"comment" : "There are examples where a medication request may include the option of an oral dose or an Intravenous or Intramuscular dose. For example, \"Ondansetron 8mg orally or IV twice a day as needed for nausea\" or \"Compazine® (prochlorperazine) 5-10mg PO or 25mg PR bid prn nausea or vomiting\". In these cases, two medication requests would be created that could be grouped together. The decision on which dose and route of administration to use is based on the patient's condition at the time the dose is needed.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Dosage"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Request.occurrence[x]"
},
{
"identity" : "rim",
"map" : "see dosageInstruction mapping"
}]
},
{
"id" : "MedicationRequest.dispenseRequest",
"path" : "MedicationRequest.dispenseRequest",
"short" : "Medication supply authorization",
"definition" : "Indicates the specific details for the dispense or medication supply part of a medication request (also known as a Medication Prescription or Medication Order). Note that this information is not always sent with the order. There may be in some settings (e.g. hospitals) institutional or system support for completing the dispense details in the pharmacy department.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "BackboneElement"
}],
"mapping" : [{
"identity" : "script10.6",
"map" : "Message/Body/NewRx/MedicationPrescribed/ExpirationDate"
},
{
"identity" : "rim",
"map" : "component.supplyEvent"
}]
},
{
"id" : "MedicationRequest.dispenseRequest.initialFill",
"path" : "MedicationRequest.dispenseRequest.initialFill",
"short" : "First fill details",
"definition" : "Indicates the quantity or duration for the first dispense of the medication.",
"comment" : "If populating this element, either the quantity or the duration must be included.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "BackboneElement"
}],
"mapping" : [{
"identity" : "rim",
"map" : "SubstanceAdministration -> ActRelationship[sequenceNumber = '1'] -> Supply"
}]
},
{
"id" : "MedicationRequest.dispenseRequest.initialFill.quantity",
"path" : "MedicationRequest.dispenseRequest.initialFill.quantity",
"short" : "First fill quantity",
"definition" : "The amount or quantity to provide as part of the first dispense.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Quantity",
"profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
}],
"mapping" : [{
"identity" : "rim",
"map" : "Supply.quantity[moodCode=RQO]"
}]
},
{
"id" : "MedicationRequest.dispenseRequest.initialFill.duration",
"path" : "MedicationRequest.dispenseRequest.initialFill.duration",
"short" : "First fill duration",
"definition" : "The length of time that the first dispense is expected to last.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Duration"
}],
"mapping" : [{
"identity" : "rim",
"map" : "Supply.effectivetime[moodCode=RQO]"
}]
},
{
"id" : "MedicationRequest.dispenseRequest.dispenseInterval",
"path" : "MedicationRequest.dispenseRequest.dispenseInterval",
"short" : "Minimum period of time between dispenses",
"definition" : "The minimum period of time that must occur between dispenses of the medication.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Duration"
}],
"mapping" : [{
"identity" : "rim",
"map" : "Supply.effectivetime[moodCode=RQO]"
}]
},
{
"id" : "MedicationRequest.dispenseRequest.validityPeriod",
"path" : "MedicationRequest.dispenseRequest.validityPeriod",
"short" : "Time period supply is authorized for",
"definition" : "This indicates the validity period of a prescription (stale dating the Prescription).",
"comment" : "It reflects the prescribers' perspective for the validity of the prescription. Dispenses must not be made against the prescription outside of this period. The lower-bound of the Dispensing Window signifies the earliest date that the prescription can be filled for the first time. If an upper-bound is not specified then the Prescription is open-ended or will default to a stale-date based on regulations.",
"requirements" : "Indicates when the Prescription becomes valid, and when it ceases to be a dispensable Prescription.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Period"
}],
"mapping" : [{
"identity" : "script10.6",
"map" : "Message/Body/NewRx/MedicationPrescribed/Refills"
},
{
"identity" : "rim",
"map" : "effectiveTime"
}]
},
{
"id" : "MedicationRequest.dispenseRequest.numberOfRepeatsAllowed",
"path" : "MedicationRequest.dispenseRequest.numberOfRepeatsAllowed",
"short" : "Number of refills authorized",
"definition" : "An integer indicating the number of times, in addition to the original dispense, (aka refills or repeats) that the patient can receive the prescribed medication. Usage Notes: This integer does not include the original order dispense. This means that if an order indicates dispense 30 tablets plus \"3 repeats\", then the order can be dispensed a total of 4 times and the patient can receive a total of 120 tablets. A prescriber may explicitly say that zero refills are permitted after the initial dispense.",
"comment" : "If displaying \"number of authorized fills\", add 1 to this number.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "unsignedInt"
}],
"mapping" : [{
"identity" : "script10.6",
"map" : "Message/Body/NewRx/MedicationPrescribed/Quantity"
},
{
"identity" : "v2",
"map" : "RXE-12-Number of Refills"
},
{
"identity" : "rim",
"map" : "repeatNumber"
}]
},
{
"id" : "MedicationRequest.dispenseRequest.quantity",
"path" : "MedicationRequest.dispenseRequest.quantity",
"short" : "Amount of medication to supply per dispense",
"definition" : "The amount that is to be dispensed for one fill.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Quantity",
"profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
}],
"mapping" : [{
"identity" : "script10.6",
"map" : "Message/Body/NewRx/MedicationPrescribed/DaysSupply"
},
{
"identity" : "v2",
"map" : "RXD-4-Actual Dispense Amount / RXD-5.1-Actual Dispense Units.code / RXD-5.3-Actual Dispense Units.name of coding system"
},
{
"identity" : "rim",
"map" : "quantity"
}]
},
{
"id" : "MedicationRequest.dispenseRequest.expectedSupplyDuration",
"path" : "MedicationRequest.dispenseRequest.expectedSupplyDuration",
"short" : "Number of days supply per dispense",
"definition" : "Identifies the period time over which the supplied product is expected to be used, or the length of time the dispense is expected to last.",
"comment" : "In some situations, this attribute may be used instead of quantity to identify the amount supplied by how long it is expected to last, rather than the physical quantity issued, e.g. 90 days supply of medication (based on an ordered dosage). When possible, it is always better to specify quantity, as this tends to be more precise. expectedSupplyDuration will always be an estimate that can be influenced by external factors.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Duration"
}],
"mapping" : [{
"identity" : "script10.6",
"map" : "Message/Body/NewRx/MedicationPrescribed/Substitutions"
},
{
"identity" : "rim",
"map" : "expectedUseTime"
}]
},
{
"id" : "MedicationRequest.dispenseRequest.performer",
"path" : "MedicationRequest.dispenseRequest.performer",
"short" : "Intended dispenser",
"definition" : "Indicates the intended dispensing Organization specified by the prescriber.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.who"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=COMP].target[classCode=SPLY, moodCode=RQO] .participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]"
}]
},
{
"id" : "MedicationRequest.substitution",
"path" : "MedicationRequest.substitution",
"short" : "Any restrictions on medication substitution",
"definition" : "Indicates whether or not substitution can or should be part of the dispense. In some cases, substitution must happen, in other cases substitution must not happen. This block explains the prescriber's intent. If nothing is specified substitution may be done.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "BackboneElement"
}],
"mapping" : [{
"identity" : "script10.6",
"map" : "specific values within Message/Body/NewRx/MedicationPrescribed/Substitutions"
},
{
"identity" : "rim",
"map" : "subjectOf.substitutionPersmission"
}]
},
{
"id" : "MedicationRequest.substitution.allowed[x]",
"path" : "MedicationRequest.substitution.allowed[x]",
"short" : "Whether substitution is allowed or not",
"definition" : "True if the prescriber allows a different drug to be dispensed from what was prescribed.",
"comment" : "This element is labeled as a modifier because whether substitution is allow or not, it cannot be ignored.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "boolean"
},
{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MedicationRequestSubstitution"
}],
"strength" : "example",
"description" : "Identifies the type of substitution allowed.",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-ActSubstanceAdminSubstitutionCode"
},
"mapping" : [{
"identity" : "script10.6",
"map" : "specific values within Message/Body/NewRx/MedicationPrescribed/Substitutions"
},
{
"identity" : "v2",
"map" : "RXO-9-Allow Substitutions / RXE-9-Substitution Status"
},
{
"identity" : "rim",
"map" : "code"
}]
},
{
"id" : "MedicationRequest.substitution.reason",
"path" : "MedicationRequest.substitution.reason",
"short" : "Why should (not) substitution be made",
"definition" : "Indicates the reason for the substitution, or why substitution must or must not be performed.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MedicationIntendedSubstitutionReason"
}],
"strength" : "example",
"description" : "A coded concept describing the reason that a different medication should (or should not) be substituted from what was prescribed.",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-SubstanceAdminSubstitutionReason"
},
"mapping" : [{
"identity" : "script10.6",
"map" : "not mapped"
},
{
"identity" : "v2",
"map" : "RXE-9 Substition status"
},
{
"identity" : "rim",
"map" : "reasonCode"
}]
},
{
"id" : "MedicationRequest.priorPrescription",
"path" : "MedicationRequest.priorPrescription",
"short" : "An order/prescription that is being replaced",
"definition" : "A link to a resource representing an earlier order related order or prescription.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/MedicationRequest"]
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Request.replaces"
},
{
"identity" : "script10.6",
"map" : "not mapped"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=?RPLC or ?SUCC]/target[classCode=SBADM,moodCode=RQO]"
}]
},
{
"id" : "MedicationRequest.detectedIssue",
"path" : "MedicationRequest.detectedIssue",
"short" : "Clinical Issue with action",
"definition" : "Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. Drug-drug interaction, duplicate therapy, dosage alert etc.",
"comment" : "This element can include a detected issue that has been identified either by a decision support system or by a clinician and may include information on the steps that were taken to address the issue.",
"alias" : ["Contraindication",
"Drug Utilization Review (DUR)",
"Alert"],
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/DetectedIssue"]
}],
"mapping" : [{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=SUBJ]/source[classCode=ALRT,moodCode=EVN].value"
}]
},
{
"id" : "MedicationRequest.eventHistory",
"path" : "MedicationRequest.eventHistory",
"short" : "A list of events of interest in the lifecycle",
"definition" : "Links to Provenance records for past versions of this resource or fulfilling request or event resources that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the resource.",
"comment" : "This might not include provenances for all versions of the request – only those deemed “relevant” or important. This SHALL NOT include the provenance associated with this current version of the resource. (If that provenance is deemed to be a “relevant” change, it will need to be added as part of a later update. Until then, it can be queried directly as the provenance that points to this version using _revinclude All Provenances should have some historical version of this Request as their subject.).",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Provenance"]
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Request.relevantHistory"
},
{
"identity" : "rim",
"map" : ".inboundRelationship(typeCode=SUBJ].source[classCode=CACT, moodCode=EVN]"
}]
}]
}
}
},
{
"fullUrl" : "http://hl7.org/fhir/StructureDefinition/MedicationStatement",
"resource" : {
"resourceType" : "StructureDefinition",
"id" : "MedicationStatement",
"meta" : {
"lastUpdated" : "2019-11-01T09:29:23.356+11:00"
},
"text" : {
"status" : "generated",
"div" : "Name Flags Card. Type Description & Constraints MedicationStatement TU DomainResource Record of medication being taken by a patient
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension identifier Σ 0..* Identifier External identifier
basedOn Σ 0..* Reference(MedicationRequest | CarePlan | ServiceRequest) Fulfils plan, proposal or order
partOf Σ 0..* Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Observation) Part of referenced event
status ?!Σ 1..1 code active | completed | entered-in-error | intended | stopped | on-hold | unknown | not-taken
Medication status codes (Required) statusReason 0..* CodeableConcept Reason for current status
SNOMED CT Drug Therapy Status codes (Example)
category Σ 0..1 CodeableConcept Type of medication usage
Medication usage category codes (Preferred) medication[x] Σ 1..1 What medication was taken
SNOMED CT Medication Codes (Example) medicationCodeableConcept CodeableConcept medicationReference Reference(Medication) subject Σ 1..1 Reference(Patient | Group) Who is/was taking the medication context Σ 0..1 Reference(Encounter | EpisodeOfCare) Encounter / Episode associated with MedicationStatement effective[x] Σ 0..1 The date/time or interval when the medication is/was/will be taken effectiveDateTime dateTime effectivePeriod Period dateAsserted Σ 0..1 dateTime When the statement was asserted? informationSource 0..1 Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization) Person or organization that provided the information about the taking of this medication derivedFrom 0..* Reference(Any) Additional supporting information
reasonCode 0..* CodeableConcept Reason for why the medication is being/was taken
Condition/Problem/Diagnosis Codes (Example)
reasonReference 0..* Reference(Condition | Observation | DiagnosticReport) Condition or observation that supports why the medication is being/was taken
note 0..* Annotation Further information about the statement
dosage 0..* Dosage Details of how medication is/was taken or should be taken
Documentation for this format
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Clinical.Medications"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 3
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "patient"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "phx"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/MedicationStatement",
"version" : "4.0.1",
"name" : "MedicationStatement",
"status" : "draft",
"date" : "2019-11-01T09:29:23+11:00",
"publisher" : "Health Level Seven International (Pharmacy)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/medication/index.cfm"
}]
}],
"description" : "A record of a medication that is being consumed by a patient. A MedicationStatement may indicate that the patient may be taking the medication now or has taken the medication in the past or will be taking the medication in the future. The source of this information can be the patient, significant other (such as a family member or spouse), or a clinician. A common scenario where this information is captured is during the history taking process during a patient visit or stay. The medication information may come from sources such as the patient's memory, from a prescription bottle, or from a list of medications the patient, clinician or other party maintains. \n\nThe primary difference between a medication statement and a medication administration is that the medication administration has complete administration information and is based on actual administration information from the person who administered the medication. A medication statement is often, if not always, less specific. There is no required date/time when the medication was administered, in fact we only know that a source has reported the patient is taking this medication, where details such as time, quantity, or rate or even medication product may be incomplete or missing or less precise. As stated earlier, the medication statement information may come from the patient's memory, from a prescription bottle or from a list of medications the patient, clinician or other party maintains. Medication administration is more formal and is not missing detailed information.",
"fhirVersion" : "4.0.1",
"mapping" : [{
"identity" : "workflow",
"uri" : "http://hl7.org/fhir/workflow",
"name" : "Workflow Pattern"
},
{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/fivews",
"name" : "FiveWs Pattern Mapping"
},
{
"identity" : "v2",
"uri" : "http://hl7.org/v2",
"name" : "HL7 v2 Mapping"
}],
"kind" : "resource",
"abstract" : false,
"type" : "MedicationStatement",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "MedicationStatement",
"path" : "MedicationStatement",
"short" : "Record of medication being taken by a patient",
"definition" : "A record of a medication that is being consumed by a patient. A MedicationStatement may indicate that the patient may be taking the medication now or has taken the medication in the past or will be taking the medication in the future. The source of this information can be the patient, significant other (such as a family member or spouse), or a clinician. A common scenario where this information is captured is during the history taking process during a patient visit or stay. The medication information may come from sources such as the patient's memory, from a prescription bottle, or from a list of medications the patient, clinician or other party maintains. \n\nThe primary difference between a medication statement and a medication administration is that the medication administration has complete administration information and is based on actual administration information from the person who administered the medication. A medication statement is often, if not always, less specific. There is no required date/time when the medication was administered, in fact we only know that a source has reported the patient is taking this medication, where details such as time, quantity, or rate or even medication product may be incomplete or missing or less precise. As stated earlier, the medication statement information may come from the patient's memory, from a prescription bottle or from a list of medications the patient, clinician or other party maintains. Medication administration is more formal and is not missing detailed information.",
"comment" : "When interpreting a medicationStatement, the value of the status and NotTaken needed to be considered:\rMedicationStatement.status + MedicationStatement.wasNotTaken\rStatus=Active + NotTaken=T = Not currently taking\rStatus=Completed + NotTaken=T = Not taken in the past\rStatus=Intended + NotTaken=T = No intention of taking\rStatus=Active + NotTaken=F = Taking, but not as prescribed\rStatus=Active + NotTaken=F = Taking\rStatus=Intended +NotTaken= F = Will be taking (not started)\rStatus=Completed + NotTaken=F = Taken in past\rStatus=In Error + NotTaken=N/A = In Error.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicationStatement",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "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",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.`div`.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "workflow",
"map" : "Event"
},
{
"identity" : "rim",
"map" : "SubstanceAdministration"
}]
},
{
"id" : "MedicationStatement.id",
"path" : "MedicationStatement.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicationStatement.meta",
"path" : "MedicationStatement.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicationStatement.implicitRules",
"path" : "MedicationStatement.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "MedicationStatement.language",
"path" : "MedicationStatement.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "MedicationStatement.text",
"path" : "MedicationStatement.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "MedicationStatement.contained",
"path" : "MedicationStatement.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MedicationStatement.extension",
"path" : "MedicationStatement.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MedicationStatement.modifierExtension",
"path" : "MedicationStatement.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MedicationStatement.identifier",
"path" : "MedicationStatement.identifier",
"short" : "External identifier",
"definition" : "Identifiers associated with this Medication Statement that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server.",
"comment" : "This is a business identifier, not a resource identifier.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicationStatement.identifier",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Identifier"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.identifier"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "rim",
"map" : ".id"
}]
},
{
"id" : "MedicationStatement.basedOn",
"path" : "MedicationStatement.basedOn",
"short" : "Fulfils plan, proposal or order",
"definition" : "A plan, proposal or order that is fulfilled in whole or in part by this event.",
"requirements" : "Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicationStatement.basedOn",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/MedicationRequest",
"http://hl7.org/fhir/StructureDefinition/CarePlan",
"http://hl7.org/fhir/StructureDefinition/ServiceRequest"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.basedOn"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=FLFS].target[classCode=SBADM or PROC or PCPR or OBS, moodCode=RQO orPLAN or PRP]"
}]
},
{
"id" : "MedicationStatement.partOf",
"path" : "MedicationStatement.partOf",
"short" : "Part of referenced event",
"definition" : "A larger event of which this particular event is a component or step.",
"requirements" : "This should not be used when indicating which resource a MedicationStatement has been derived from. If that is the use case, then MedicationStatement.derivedFrom should be used.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicationStatement.partOf",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/MedicationAdministration",
"http://hl7.org/fhir/StructureDefinition/MedicationDispense",
"http://hl7.org/fhir/StructureDefinition/MedicationStatement",
"http://hl7.org/fhir/StructureDefinition/Procedure",
"http://hl7.org/fhir/StructureDefinition/Observation"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.partOf"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=COMP]/target[classCode=SPLY or SBADM or PROC or OBS,moodCode=EVN]"
}]
},
{
"id" : "MedicationStatement.status",
"path" : "MedicationStatement.status",
"short" : "active | completed | entered-in-error | intended | stopped | on-hold | unknown | not-taken",
"definition" : "A code representing the patient or other source's judgment about the state of the medication used that this statement is about. Generally, this will be active or completed.",
"comment" : "MedicationStatement is a statement at a point in time. The status is only representative at the point when it was asserted. The value set for MedicationStatement.status contains codes that assert the status of the use of the medication by the patient (for example, stopped or on hold) as well as codes that assert the status of the medication statement itself (for example, entered in error).\r\rThis element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "MedicationStatement.status",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MedicationStatementStatus"
}],
"strength" : "required",
"description" : "A coded concept indicating the current status of a MedicationStatement.",
"valueSet" : "http://hl7.org/fhir/ValueSet/medication-statement-status|4.0.1"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.status"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
},
{
"identity" : "rim",
"map" : ".statusCode"
}]
},
{
"id" : "MedicationStatement.statusReason",
"path" : "MedicationStatement.statusReason",
"short" : "Reason for current status",
"definition" : "Captures the reason for the current state of the MedicationStatement.",
"comment" : "This is generally only used for \"exception\" statuses such as \"not-taken\", \"on-hold\", \"cancelled\" or \"entered-in-error\". The reason for performing the event at all is captured in reasonCode, not here.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicationStatement.statusReason",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MedicationStatementStatusReason"
}],
"strength" : "example",
"description" : "A coded concept indicating the reason for the status of the statement.",
"valueSet" : "http://hl7.org/fhir/ValueSet/reason-medication-status-codes"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.statusReason"
},
{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=SUBJ].source[classCode=CACT, moodCode=EVN].reasonCOde"
}]
},
{
"id" : "MedicationStatement.category",
"path" : "MedicationStatement.category",
"short" : "Type of medication usage",
"definition" : "Indicates where the medication is expected to be consumed or administered.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicationStatement.category",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MedicationStatementCategory"
}],
"strength" : "preferred",
"description" : "A coded concept identifying where the medication included in the MedicationStatement is expected to be consumed or administered.",
"valueSet" : "http://hl7.org/fhir/ValueSet/medication-statement-category"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.class"
},
{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=COMP].source[classCode=OBS, moodCode=EVN, code=\"type of medication usage\"].value"
}]
},
{
"id" : "MedicationStatement.medication[x]",
"path" : "MedicationStatement.medication[x]",
"short" : "What medication was taken",
"definition" : "Identifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.",
"comment" : "If only a code is specified, then it needs to be a code for a specific product. If more information is required, then the use of the medication resource is recommended. For example, if you require form or lot number, then you must reference the Medication resource.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "MedicationStatement.medication[x]",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
},
{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Medication"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MedicationCode"
}],
"strength" : "example",
"description" : "A coded concept identifying the substance or product being taken.",
"valueSet" : "http://hl7.org/fhir/ValueSet/medication-codes"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.code"
},
{
"identity" : "w5",
"map" : "FiveWs.what[x]"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=CSM].role[classCode=ADMM or MANU]"
}]
},
{
"id" : "MedicationStatement.subject",
"path" : "MedicationStatement.subject",
"short" : "Who is/was taking the medication",
"definition" : "The person, animal or group who is/was taking the medication.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "MedicationStatement.subject",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Group"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.subject"
},
{
"identity" : "w5",
"map" : "FiveWs.subject[x]"
},
{
"identity" : "v2",
"map" : "PID-3-Patient ID List"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=SBJ].role[classCode=PAT]"
},
{
"identity" : "w5",
"map" : "FiveWs.subject"
}]
},
{
"id" : "MedicationStatement.context",
"path" : "MedicationStatement.context",
"short" : "Encounter / Episode associated with MedicationStatement",
"definition" : "The encounter or episode of care that establishes the context for this MedicationStatement.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicationStatement.context",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Encounter",
"http://hl7.org/fhir/StructureDefinition/EpisodeOfCare"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.context"
},
{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN, code=\"type of encounter or episode\"]"
}]
},
{
"id" : "MedicationStatement.effective[x]",
"path" : "MedicationStatement.effective[x]",
"short" : "The date/time or interval when the medication is/was/will be taken",
"definition" : "The interval of time during which it is being asserted that the patient is/was/will be taking the medication (or was not taking, when the MedicationStatement.taken element is No).",
"comment" : "This attribute reflects the period over which the patient consumed the medication and is expected to be populated on the majority of Medication Statements. If the medication is still being taken at the time the statement is recorded, the \"end\" date will be omitted. The date/time attribute supports a variety of dates - year, year/month and exact date. If something more than this is required, this should be conveyed as text.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicationStatement.effective[x]",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
},
{
"code" : "Period"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.occurrence[x]"
},
{
"identity" : "w5",
"map" : "FiveWs.done[x]"
},
{
"identity" : "rim",
"map" : ".effectiveTime"
}]
},
{
"id" : "MedicationStatement.dateAsserted",
"path" : "MedicationStatement.dateAsserted",
"short" : "When the statement was asserted?",
"definition" : "The date when the medication statement was asserted by the information source.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicationStatement.dateAsserted",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.recorded"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=AUT].time"
}]
},
{
"id" : "MedicationStatement.informationSource",
"path" : "MedicationStatement.informationSource",
"short" : "Person or organization that provided the information about the taking of this medication",
"definition" : "The person or organization that provided the information about the taking of this medication. Note: Use derivedFrom when a MedicationStatement is derived from other resources, e.g. Claim or MedicationRequest.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicationStatement.informationSource",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson",
"http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.source"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=INF].role[classCode=PAT, or codes for Practioner or Related Person (if PAT is the informer, then syntax for self-reported =true)"
}]
},
{
"id" : "MedicationStatement.derivedFrom",
"path" : "MedicationStatement.derivedFrom",
"short" : "Additional supporting information",
"definition" : "Allows linking the MedicationStatement to the underlying MedicationRequest, or to other information that supports or is used to derive the MedicationStatement.",
"comment" : "Likely references would be to MedicationRequest, MedicationDispense, Claim, Observation or QuestionnaireAnswers. The most common use cases for deriving a MedicationStatement comes from creating a MedicationStatement from a MedicationRequest or from a lab observation or a claim. it should be noted that the amount of information that is available varies from the type resource that you derive the MedicationStatement from.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicationStatement.derivedFrom",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=SPRT]/target[classCode=ACT,moodCode=EVN]"
}]
},
{
"id" : "MedicationStatement.reasonCode",
"path" : "MedicationStatement.reasonCode",
"short" : "Reason for why the medication is being/was taken",
"definition" : "A reason for why the medication is being/was taken.",
"comment" : "This could be a diagnosis code. If a full condition record exists or additional detail is needed, use reasonForUseReference.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicationStatement.reasonCode",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MedicationReason"
}],
"strength" : "example",
"description" : "A coded concept identifying why the medication is being taken.",
"valueSet" : "http://hl7.org/fhir/ValueSet/condition-code"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.reasonCode"
},
{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "rim",
"map" : ".reasonCode"
}]
},
{
"id" : "MedicationStatement.reasonReference",
"path" : "MedicationStatement.reasonReference",
"short" : "Condition or observation that supports why the medication is being/was taken",
"definition" : "Condition or observation that supports why the medication is being/was taken.",
"comment" : "This is a reference to a condition that is the reason why the medication is being/was taken. If only a code exists, use reasonForUseCode.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicationStatement.reasonReference",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Condition",
"http://hl7.org/fhir/StructureDefinition/Observation",
"http://hl7.org/fhir/StructureDefinition/DiagnosticReport"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.reasonReference"
},
{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=RSON]/target[classCode=OBS,moodCode=EVN, code=\"reason for use\"].value"
}]
},
{
"id" : "MedicationStatement.note",
"path" : "MedicationStatement.note",
"short" : "Further information about the statement",
"definition" : "Provides extra information about the medication statement that is not conveyed by the other attributes.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicationStatement.note",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Annotation"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.note"
},
{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=SUBJ]/source[classCode=OBS,moodCode=EVN,code=\"annotation\"].value"
}]
},
{
"id" : "MedicationStatement.dosage",
"path" : "MedicationStatement.dosage",
"short" : "Details of how medication is/was taken or should be taken",
"definition" : "Indicates how the medication is/was or should be taken by the patient.",
"comment" : "The dates included in the dosage on a Medication Statement reflect the dates for a given dose. For example, \"from November 1, 2016 to November 3, 2016, take one tablet daily and from November 4, 2016 to November 7, 2016, take two tablets daily.\" It is expected that this specificity may only be populated where the patient brings in their labeled container or where the Medication Statement is derived from a MedicationRequest.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicationStatement.dosage",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Dosage"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "refer dosageInstruction mapping"
}]
}]
},
"differential" : {
"element" : [{
"id" : "MedicationStatement",
"path" : "MedicationStatement",
"short" : "Record of medication being taken by a patient",
"definition" : "A record of a medication that is being consumed by a patient. A MedicationStatement may indicate that the patient may be taking the medication now or has taken the medication in the past or will be taking the medication in the future. The source of this information can be the patient, significant other (such as a family member or spouse), or a clinician. A common scenario where this information is captured is during the history taking process during a patient visit or stay. The medication information may come from sources such as the patient's memory, from a prescription bottle, or from a list of medications the patient, clinician or other party maintains. \n\nThe primary difference between a medication statement and a medication administration is that the medication administration has complete administration information and is based on actual administration information from the person who administered the medication. A medication statement is often, if not always, less specific. There is no required date/time when the medication was administered, in fact we only know that a source has reported the patient is taking this medication, where details such as time, quantity, or rate or even medication product may be incomplete or missing or less precise. As stated earlier, the medication statement information may come from the patient's memory, from a prescription bottle or from a list of medications the patient, clinician or other party maintains. Medication administration is more formal and is not missing detailed information.",
"comment" : "When interpreting a medicationStatement, the value of the status and NotTaken needed to be considered:\rMedicationStatement.status + MedicationStatement.wasNotTaken\rStatus=Active + NotTaken=T = Not currently taking\rStatus=Completed + NotTaken=T = Not taken in the past\rStatus=Intended + NotTaken=T = No intention of taking\rStatus=Active + NotTaken=F = Taking, but not as prescribed\rStatus=Active + NotTaken=F = Taking\rStatus=Intended +NotTaken= F = Will be taking (not started)\rStatus=Completed + NotTaken=F = Taken in past\rStatus=In Error + NotTaken=N/A = In Error.",
"min" : 0,
"max" : "*",
"mapping" : [{
"identity" : "workflow",
"map" : "Event"
},
{
"identity" : "rim",
"map" : "SubstanceAdministration"
}]
},
{
"id" : "MedicationStatement.identifier",
"path" : "MedicationStatement.identifier",
"short" : "External identifier",
"definition" : "Identifiers associated with this Medication Statement that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server.",
"comment" : "This is a business identifier, not a resource identifier.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Identifier"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.identifier"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "rim",
"map" : ".id"
}]
},
{
"id" : "MedicationStatement.basedOn",
"path" : "MedicationStatement.basedOn",
"short" : "Fulfils plan, proposal or order",
"definition" : "A plan, proposal or order that is fulfilled in whole or in part by this event.",
"requirements" : "Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/MedicationRequest",
"http://hl7.org/fhir/StructureDefinition/CarePlan",
"http://hl7.org/fhir/StructureDefinition/ServiceRequest"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.basedOn"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=FLFS].target[classCode=SBADM or PROC or PCPR or OBS, moodCode=RQO orPLAN or PRP]"
}]
},
{
"id" : "MedicationStatement.partOf",
"path" : "MedicationStatement.partOf",
"short" : "Part of referenced event",
"definition" : "A larger event of which this particular event is a component or step.",
"requirements" : "This should not be used when indicating which resource a MedicationStatement has been derived from. If that is the use case, then MedicationStatement.derivedFrom should be used.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/MedicationAdministration",
"http://hl7.org/fhir/StructureDefinition/MedicationDispense",
"http://hl7.org/fhir/StructureDefinition/MedicationStatement",
"http://hl7.org/fhir/StructureDefinition/Procedure",
"http://hl7.org/fhir/StructureDefinition/Observation"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.partOf"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=COMP]/target[classCode=SPLY or SBADM or PROC or OBS,moodCode=EVN]"
}]
},
{
"id" : "MedicationStatement.status",
"path" : "MedicationStatement.status",
"short" : "active | completed | entered-in-error | intended | stopped | on-hold | unknown | not-taken",
"definition" : "A code representing the patient or other source's judgment about the state of the medication used that this statement is about. Generally, this will be active or completed.",
"comment" : "MedicationStatement is a statement at a point in time. The status is only representative at the point when it was asserted. The value set for MedicationStatement.status contains codes that assert the status of the use of the medication by the patient (for example, stopped or on hold) as well as codes that assert the status of the medication statement itself (for example, entered in error).\r\rThis element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isModifier" : true,
"isModifierReason" : "This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MedicationStatementStatus"
}],
"strength" : "required",
"description" : "A coded concept indicating the current status of a MedicationStatement.",
"valueSet" : "http://hl7.org/fhir/ValueSet/medication-statement-status|4.0.1"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.status"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
},
{
"identity" : "rim",
"map" : ".statusCode"
}]
},
{
"id" : "MedicationStatement.statusReason",
"path" : "MedicationStatement.statusReason",
"short" : "Reason for current status",
"definition" : "Captures the reason for the current state of the MedicationStatement.",
"comment" : "This is generally only used for \"exception\" statuses such as \"not-taken\", \"on-hold\", \"cancelled\" or \"entered-in-error\". The reason for performing the event at all is captured in reasonCode, not here.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MedicationStatementStatusReason"
}],
"strength" : "example",
"description" : "A coded concept indicating the reason for the status of the statement.",
"valueSet" : "http://hl7.org/fhir/ValueSet/reason-medication-status-codes"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.statusReason"
},
{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=SUBJ].source[classCode=CACT, moodCode=EVN].reasonCOde"
}]
},
{
"id" : "MedicationStatement.category",
"path" : "MedicationStatement.category",
"short" : "Type of medication usage",
"definition" : "Indicates where the medication is expected to be consumed or administered.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MedicationStatementCategory"
}],
"strength" : "preferred",
"description" : "A coded concept identifying where the medication included in the MedicationStatement is expected to be consumed or administered.",
"valueSet" : "http://hl7.org/fhir/ValueSet/medication-statement-category"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.class"
},
{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=COMP].source[classCode=OBS, moodCode=EVN, code=\"type of medication usage\"].value"
}]
},
{
"id" : "MedicationStatement.medication[x]",
"path" : "MedicationStatement.medication[x]",
"short" : "What medication was taken",
"definition" : "Identifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.",
"comment" : "If only a code is specified, then it needs to be a code for a specific product. If more information is required, then the use of the medication resource is recommended. For example, if you require form or lot number, then you must reference the Medication resource.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
},
{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Medication"]
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MedicationCode"
}],
"strength" : "example",
"description" : "A coded concept identifying the substance or product being taken.",
"valueSet" : "http://hl7.org/fhir/ValueSet/medication-codes"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.code"
},
{
"identity" : "w5",
"map" : "FiveWs.what[x]"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=CSM].role[classCode=ADMM or MANU]"
}]
},
{
"id" : "MedicationStatement.subject",
"path" : "MedicationStatement.subject",
"short" : "Who is/was taking the medication",
"definition" : "The person, animal or group who is/was taking the medication.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Group"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.subject"
},
{
"identity" : "w5",
"map" : "FiveWs.subject[x]"
},
{
"identity" : "v2",
"map" : "PID-3-Patient ID List"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=SBJ].role[classCode=PAT]"
},
{
"identity" : "w5",
"map" : "FiveWs.subject"
}]
},
{
"id" : "MedicationStatement.context",
"path" : "MedicationStatement.context",
"short" : "Encounter / Episode associated with MedicationStatement",
"definition" : "The encounter or episode of care that establishes the context for this MedicationStatement.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Encounter",
"http://hl7.org/fhir/StructureDefinition/EpisodeOfCare"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.context"
},
{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN, code=\"type of encounter or episode\"]"
}]
},
{
"id" : "MedicationStatement.effective[x]",
"path" : "MedicationStatement.effective[x]",
"short" : "The date/time or interval when the medication is/was/will be taken",
"definition" : "The interval of time during which it is being asserted that the patient is/was/will be taking the medication (or was not taking, when the MedicationStatement.taken element is No).",
"comment" : "This attribute reflects the period over which the patient consumed the medication and is expected to be populated on the majority of Medication Statements. If the medication is still being taken at the time the statement is recorded, the \"end\" date will be omitted. The date/time attribute supports a variety of dates - year, year/month and exact date. If something more than this is required, this should be conveyed as text.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "dateTime"
},
{
"code" : "Period"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.occurrence[x]"
},
{
"identity" : "w5",
"map" : "FiveWs.done[x]"
},
{
"identity" : "rim",
"map" : ".effectiveTime"
}]
},
{
"id" : "MedicationStatement.dateAsserted",
"path" : "MedicationStatement.dateAsserted",
"short" : "When the statement was asserted?",
"definition" : "The date when the medication statement was asserted by the information source.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "dateTime"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.recorded"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=AUT].time"
}]
},
{
"id" : "MedicationStatement.informationSource",
"path" : "MedicationStatement.informationSource",
"short" : "Person or organization that provided the information about the taking of this medication",
"definition" : "The person or organization that provided the information about the taking of this medication. Note: Use derivedFrom when a MedicationStatement is derived from other resources, e.g. Claim or MedicationRequest.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson",
"http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.source"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=INF].role[classCode=PAT, or codes for Practioner or Related Person (if PAT is the informer, then syntax for self-reported =true)"
}]
},
{
"id" : "MedicationStatement.derivedFrom",
"path" : "MedicationStatement.derivedFrom",
"short" : "Additional supporting information",
"definition" : "Allows linking the MedicationStatement to the underlying MedicationRequest, or to other information that supports or is used to derive the MedicationStatement.",
"comment" : "Likely references would be to MedicationRequest, MedicationDispense, Claim, Observation or QuestionnaireAnswers. The most common use cases for deriving a MedicationStatement comes from creating a MedicationStatement from a MedicationRequest or from a lab observation or a claim. it should be noted that the amount of information that is available varies from the type resource that you derive the MedicationStatement from.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"mapping" : [{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=SPRT]/target[classCode=ACT,moodCode=EVN]"
}]
},
{
"id" : "MedicationStatement.reasonCode",
"path" : "MedicationStatement.reasonCode",
"short" : "Reason for why the medication is being/was taken",
"definition" : "A reason for why the medication is being/was taken.",
"comment" : "This could be a diagnosis code. If a full condition record exists or additional detail is needed, use reasonForUseReference.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MedicationReason"
}],
"strength" : "example",
"description" : "A coded concept identifying why the medication is being taken.",
"valueSet" : "http://hl7.org/fhir/ValueSet/condition-code"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.reasonCode"
},
{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "rim",
"map" : ".reasonCode"
}]
},
{
"id" : "MedicationStatement.reasonReference",
"path" : "MedicationStatement.reasonReference",
"short" : "Condition or observation that supports why the medication is being/was taken",
"definition" : "Condition or observation that supports why the medication is being/was taken.",
"comment" : "This is a reference to a condition that is the reason why the medication is being/was taken. If only a code exists, use reasonForUseCode.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Condition",
"http://hl7.org/fhir/StructureDefinition/Observation",
"http://hl7.org/fhir/StructureDefinition/DiagnosticReport"]
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Event.reasonReference"
},
{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=RSON]/target[classCode=OBS,moodCode=EVN, code=\"reason for use\"].value"
}]
},
{
"id" : "MedicationStatement.note",
"path" : "MedicationStatement.note",
"short" : "Further information about the statement",
"definition" : "Provides extra information about the medication statement that is not conveyed by the other attributes.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Annotation"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Event.note"
},
{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=SUBJ]/source[classCode=OBS,moodCode=EVN,code=\"annotation\"].value"
}]
},
{
"id" : "MedicationStatement.dosage",
"path" : "MedicationStatement.dosage",
"short" : "Details of how medication is/was taken or should be taken",
"definition" : "Indicates how the medication is/was or should be taken by the patient.",
"comment" : "The dates included in the dosage on a Medication Statement reflect the dates for a given dose. For example, \"from November 1, 2016 to November 3, 2016, take one tablet daily and from November 4, 2016 to November 7, 2016, take two tablets daily.\" It is expected that this specificity may only be populated where the patient brings in their labeled container or where the Medication Statement is derived from a MedicationRequest.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Dosage"
}],
"mapping" : [{
"identity" : "rim",
"map" : "refer dosageInstruction mapping"
}]
}]
}
}
},
{
"fullUrl" : "http://hl7.org/fhir/StructureDefinition/MedicinalProduct",
"resource" : {
"resourceType" : "StructureDefinition",
"id" : "MedicinalProduct",
"meta" : {
"lastUpdated" : "2019-11-01T09:29:23.356+11:00"
},
"text" : {
"status" : "generated",
"div" : "Name Flags Card. Type Description & Constraints MedicinalProduct ΣTU DomainResource Detailed definition of a medicinal product, typically for uses other than direct patient care (e.g. regulatory use)
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension identifier Σ 0..* Identifier Business identifier for this product. Could be an MPID
type Σ 0..1 CodeableConcept Regulatory type, e.g. Investigational or Authorized domain Σ 0..1 Coding If this medicine applies to human or veterinary uses combinedPharmaceuticalDoseForm Σ 0..1 CodeableConcept The dose form for a single part product, or combined form of a multiple part product legalStatusOfSupply Σ 0..1 CodeableConcept The legal status of supply of the medicinal product as classified by the regulator additionalMonitoringIndicator Σ 0..1 CodeableConcept Whether the Medicinal Product is subject to additional monitoring for regulatory reasons specialMeasures Σ 0..* string Whether the Medicinal Product is subject to special measures for regulatory reasons
paediatricUseIndicator Σ 0..1 CodeableConcept If authorised for use in children productClassification Σ 0..* CodeableConcept Allows the product to be classified by various systems
marketingStatus Σ 0..* MarketingStatus Marketing status of the medicinal product, in contrast to marketing authorizaton
pharmaceuticalProduct Σ 0..* Reference(MedicinalProductPharmaceutical) Pharmaceutical aspects of product
packagedMedicinalProduct Σ 0..* Reference(MedicinalProductPackaged) Package representation for the product
attachedDocument Σ 0..* Reference(DocumentReference) Supporting documentation, typically for regulatory submission
masterFile Σ 0..* Reference(DocumentReference) A master file for to the medicinal product (e.g. Pharmacovigilance System Master File)
contact Σ 0..* Reference(Organization | PractitionerRole) A product specific contact, person (in a role), or an organization
clinicalTrial Σ 0..* Reference(ResearchStudy) Clinical trials or studies that this product is involved in
name Σ 1..* BackboneElement The product's name, including full name and possibly coded parts
productName Σ 1..1 string The full product name namePart Σ 0..* BackboneElement Coding words or phrases of the name
part Σ 1..1 string A fragment of a product name type Σ 1..1 Coding Idenifying type for this part of the name (e.g. strength part) countryLanguage Σ 0..* BackboneElement Country where the name applies
country Σ 1..1 CodeableConcept Country code for where this name applies jurisdiction Σ 0..1 CodeableConcept Jurisdiction code for where this name applies language Σ 1..1 CodeableConcept Language code for this name crossReference Σ 0..* Identifier Reference to another product, e.g. for linking authorised to investigational product
manufacturingBusinessOperation Σ 0..* BackboneElement An operation applied to the product, for manufacturing or adminsitrative purpose
operationType Σ 0..1 CodeableConcept The type of manufacturing operation authorisationReferenceNumber Σ 0..1 Identifier Regulatory authorization reference number effectiveDate Σ 0..1 dateTime Regulatory authorization date confidentialityIndicator Σ 0..1 CodeableConcept To indicate if this proces is commercially confidential manufacturer Σ 0..* Reference(Organization) The manufacturer or establishment associated with the process
regulator Σ 0..1 Reference(Organization) A regulator which oversees the operation specialDesignation Σ 0..* BackboneElement Indicates if the medicinal product has an orphan designation for the treatment of a rare disease
identifier Σ 0..* Identifier Identifier for the designation, or procedure number
type Σ 0..1 CodeableConcept The type of special designation, e.g. orphan drug, minor use intendedUse Σ 0..1 CodeableConcept The intended use of the product, e.g. prevention, treatment indication[x] Σ 0..1 Condition for which the medicinal use applies indicationCodeableConcept CodeableConcept indicationReference Reference(MedicinalProductIndication) status Σ 0..1 CodeableConcept For example granted, pending, expired or withdrawn date Σ 0..1 dateTime Date when the designation was granted species Σ 0..1 CodeableConcept Animal species for which this applies
Documentation for this format
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Specialized.Medication Definition"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 0
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "anonymous"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "brr"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/MedicinalProduct",
"version" : "4.0.1",
"name" : "MedicinalProduct",
"status" : "draft",
"date" : "2019-11-01T09:29:23+11:00",
"publisher" : "Health Level Seven International (Biomedical Research and Regulation)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/rcrim/index.cfm"
}]
}],
"description" : "Detailed definition of a medicinal product, typically for uses other than direct patient care (e.g. regulatory use).",
"fhirVersion" : "4.0.1",
"mapping" : [{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
}],
"kind" : "resource",
"abstract" : false,
"type" : "MedicinalProduct",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "MedicinalProduct",
"path" : "MedicinalProduct",
"short" : "Detailed definition of a medicinal product, typically for uses other than direct patient care (e.g. regulatory use)",
"definition" : "Detailed definition of a medicinal product, typically for uses other than direct patient care (e.g. regulatory use).",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicinalProduct",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "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",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.`div`.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
}]
},
{
"id" : "MedicinalProduct.id",
"path" : "MedicinalProduct.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProduct.meta",
"path" : "MedicinalProduct.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProduct.implicitRules",
"path" : "MedicinalProduct.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "MedicinalProduct.language",
"path" : "MedicinalProduct.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "MedicinalProduct.text",
"path" : "MedicinalProduct.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "MedicinalProduct.contained",
"path" : "MedicinalProduct.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MedicinalProduct.extension",
"path" : "MedicinalProduct.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MedicinalProduct.modifierExtension",
"path" : "MedicinalProduct.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MedicinalProduct.identifier",
"path" : "MedicinalProduct.identifier",
"short" : "Business identifier for this product. Could be an MPID",
"definition" : "Business identifier for this product. Could be an MPID.",
"alias" : ["MPID"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicinalProduct.identifier",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Identifier"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProduct.type",
"path" : "MedicinalProduct.type",
"short" : "Regulatory type, e.g. Investigational or Authorized",
"definition" : "Regulatory type, e.g. Investigational or Authorized.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicinalProduct.type",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProduct.domain",
"path" : "MedicinalProduct.domain",
"short" : "If this medicine applies to human or veterinary uses",
"definition" : "If this medicine applies to human or veterinary uses.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicinalProduct.domain",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Coding"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProduct.combinedPharmaceuticalDoseForm",
"path" : "MedicinalProduct.combinedPharmaceuticalDoseForm",
"short" : "The dose form for a single part product, or combined form of a multiple part product",
"definition" : "The dose form for a single part product, or combined form of a multiple part product.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicinalProduct.combinedPharmaceuticalDoseForm",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProduct.legalStatusOfSupply",
"path" : "MedicinalProduct.legalStatusOfSupply",
"short" : "The legal status of supply of the medicinal product as classified by the regulator",
"definition" : "The legal status of supply of the medicinal product as classified by the regulator.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicinalProduct.legalStatusOfSupply",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProduct.additionalMonitoringIndicator",
"path" : "MedicinalProduct.additionalMonitoringIndicator",
"short" : "Whether the Medicinal Product is subject to additional monitoring for regulatory reasons",
"definition" : "Whether the Medicinal Product is subject to additional monitoring for regulatory reasons.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicinalProduct.additionalMonitoringIndicator",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProduct.specialMeasures",
"path" : "MedicinalProduct.specialMeasures",
"short" : "Whether the Medicinal Product is subject to special measures for regulatory reasons",
"definition" : "Whether the Medicinal Product is subject to special measures for regulatory reasons.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicinalProduct.specialMeasures",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProduct.paediatricUseIndicator",
"path" : "MedicinalProduct.paediatricUseIndicator",
"short" : "If authorised for use in children",
"definition" : "If authorised for use in children.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicinalProduct.paediatricUseIndicator",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProduct.productClassification",
"path" : "MedicinalProduct.productClassification",
"short" : "Allows the product to be classified by various systems",
"definition" : "Allows the product to be classified by various systems.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicinalProduct.productClassification",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProduct.marketingStatus",
"path" : "MedicinalProduct.marketingStatus",
"short" : "Marketing status of the medicinal product, in contrast to marketing authorizaton",
"definition" : "Marketing status of the medicinal product, in contrast to marketing authorizaton.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicinalProduct.marketingStatus",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "MarketingStatus"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProduct.pharmaceuticalProduct",
"path" : "MedicinalProduct.pharmaceuticalProduct",
"short" : "Pharmaceutical aspects of product",
"definition" : "Pharmaceutical aspects of product.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicinalProduct.pharmaceuticalProduct",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/MedicinalProductPharmaceutical"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProduct.packagedMedicinalProduct",
"path" : "MedicinalProduct.packagedMedicinalProduct",
"short" : "Package representation for the product",
"definition" : "Package representation for the product.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicinalProduct.packagedMedicinalProduct",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/MedicinalProductPackaged"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProduct.attachedDocument",
"path" : "MedicinalProduct.attachedDocument",
"short" : "Supporting documentation, typically for regulatory submission",
"definition" : "Supporting documentation, typically for regulatory submission.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicinalProduct.attachedDocument",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/DocumentReference"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProduct.masterFile",
"path" : "MedicinalProduct.masterFile",
"short" : "A master file for to the medicinal product (e.g. Pharmacovigilance System Master File)",
"definition" : "A master file for to the medicinal product (e.g. Pharmacovigilance System Master File).",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicinalProduct.masterFile",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/DocumentReference"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProduct.contact",
"path" : "MedicinalProduct.contact",
"short" : "A product specific contact, person (in a role), or an organization",
"definition" : "A product specific contact, person (in a role), or an organization.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicinalProduct.contact",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProduct.clinicalTrial",
"path" : "MedicinalProduct.clinicalTrial",
"short" : "Clinical trials or studies that this product is involved in",
"definition" : "Clinical trials or studies that this product is involved in.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicinalProduct.clinicalTrial",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ResearchStudy"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProduct.name",
"path" : "MedicinalProduct.name",
"short" : "The product's name, including full name and possibly coded parts",
"definition" : "The product's name, including full name and possibly coded parts.",
"min" : 1,
"max" : "*",
"base" : {
"path" : "MedicinalProduct.name",
"min" : 1,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProduct.name.id",
"path" : "MedicinalProduct.name.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MedicinalProduct.name.extension",
"path" : "MedicinalProduct.name.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MedicinalProduct.name.modifierExtension",
"path" : "MedicinalProduct.name.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MedicinalProduct.name.productName",
"path" : "MedicinalProduct.name.productName",
"short" : "The full product name",
"definition" : "The full product name.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "MedicinalProduct.name.productName",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProduct.name.namePart",
"path" : "MedicinalProduct.name.namePart",
"short" : "Coding words or phrases of the name",
"definition" : "Coding words or phrases of the name.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicinalProduct.name.namePart",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProduct.name.namePart.id",
"path" : "MedicinalProduct.name.namePart.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MedicinalProduct.name.namePart.extension",
"path" : "MedicinalProduct.name.namePart.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MedicinalProduct.name.namePart.modifierExtension",
"path" : "MedicinalProduct.name.namePart.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MedicinalProduct.name.namePart.part",
"path" : "MedicinalProduct.name.namePart.part",
"short" : "A fragment of a product name",
"definition" : "A fragment of a product name.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "MedicinalProduct.name.namePart.part",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProduct.name.namePart.type",
"path" : "MedicinalProduct.name.namePart.type",
"short" : "Idenifying type for this part of the name (e.g. strength part)",
"definition" : "Idenifying type for this part of the name (e.g. strength part).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "MedicinalProduct.name.namePart.type",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "Coding"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProduct.name.countryLanguage",
"path" : "MedicinalProduct.name.countryLanguage",
"short" : "Country where the name applies",
"definition" : "Country where the name applies.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicinalProduct.name.countryLanguage",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProduct.name.countryLanguage.id",
"path" : "MedicinalProduct.name.countryLanguage.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MedicinalProduct.name.countryLanguage.extension",
"path" : "MedicinalProduct.name.countryLanguage.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MedicinalProduct.name.countryLanguage.modifierExtension",
"path" : "MedicinalProduct.name.countryLanguage.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MedicinalProduct.name.countryLanguage.country",
"path" : "MedicinalProduct.name.countryLanguage.country",
"short" : "Country code for where this name applies",
"definition" : "Country code for where this name applies.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "MedicinalProduct.name.countryLanguage.country",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProduct.name.countryLanguage.jurisdiction",
"path" : "MedicinalProduct.name.countryLanguage.jurisdiction",
"short" : "Jurisdiction code for where this name applies",
"definition" : "Jurisdiction code for where this name applies.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicinalProduct.name.countryLanguage.jurisdiction",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProduct.name.countryLanguage.language",
"path" : "MedicinalProduct.name.countryLanguage.language",
"short" : "Language code for this name",
"definition" : "Language code for this name.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "MedicinalProduct.name.countryLanguage.language",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProduct.crossReference",
"path" : "MedicinalProduct.crossReference",
"short" : "Reference to another product, e.g. for linking authorised to investigational product",
"definition" : "Reference to another product, e.g. for linking authorised to investigational product.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicinalProduct.crossReference",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Identifier"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProduct.manufacturingBusinessOperation",
"path" : "MedicinalProduct.manufacturingBusinessOperation",
"short" : "An operation applied to the product, for manufacturing or adminsitrative purpose",
"definition" : "An operation applied to the product, for manufacturing or adminsitrative purpose.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicinalProduct.manufacturingBusinessOperation",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProduct.manufacturingBusinessOperation.id",
"path" : "MedicinalProduct.manufacturingBusinessOperation.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MedicinalProduct.manufacturingBusinessOperation.extension",
"path" : "MedicinalProduct.manufacturingBusinessOperation.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MedicinalProduct.manufacturingBusinessOperation.modifierExtension",
"path" : "MedicinalProduct.manufacturingBusinessOperation.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MedicinalProduct.manufacturingBusinessOperation.operationType",
"path" : "MedicinalProduct.manufacturingBusinessOperation.operationType",
"short" : "The type of manufacturing operation",
"definition" : "The type of manufacturing operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicinalProduct.manufacturingBusinessOperation.operationType",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProduct.manufacturingBusinessOperation.authorisationReferenceNumber",
"path" : "MedicinalProduct.manufacturingBusinessOperation.authorisationReferenceNumber",
"short" : "Regulatory authorization reference number",
"definition" : "Regulatory authorization reference number.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicinalProduct.manufacturingBusinessOperation.authorisationReferenceNumber",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Identifier"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProduct.manufacturingBusinessOperation.effectiveDate",
"path" : "MedicinalProduct.manufacturingBusinessOperation.effectiveDate",
"short" : "Regulatory authorization date",
"definition" : "Regulatory authorization date.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicinalProduct.manufacturingBusinessOperation.effectiveDate",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProduct.manufacturingBusinessOperation.confidentialityIndicator",
"path" : "MedicinalProduct.manufacturingBusinessOperation.confidentialityIndicator",
"short" : "To indicate if this proces is commercially confidential",
"definition" : "To indicate if this proces is commercially confidential.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicinalProduct.manufacturingBusinessOperation.confidentialityIndicator",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProduct.manufacturingBusinessOperation.manufacturer",
"path" : "MedicinalProduct.manufacturingBusinessOperation.manufacturer",
"short" : "The manufacturer or establishment associated with the process",
"definition" : "The manufacturer or establishment associated with the process.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicinalProduct.manufacturingBusinessOperation.manufacturer",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProduct.manufacturingBusinessOperation.regulator",
"path" : "MedicinalProduct.manufacturingBusinessOperation.regulator",
"short" : "A regulator which oversees the operation",
"definition" : "A regulator which oversees the operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicinalProduct.manufacturingBusinessOperation.regulator",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProduct.specialDesignation",
"path" : "MedicinalProduct.specialDesignation",
"short" : "Indicates if the medicinal product has an orphan designation for the treatment of a rare disease",
"definition" : "Indicates if the medicinal product has an orphan designation for the treatment of a rare disease.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicinalProduct.specialDesignation",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProduct.specialDesignation.id",
"path" : "MedicinalProduct.specialDesignation.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MedicinalProduct.specialDesignation.extension",
"path" : "MedicinalProduct.specialDesignation.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MedicinalProduct.specialDesignation.modifierExtension",
"path" : "MedicinalProduct.specialDesignation.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MedicinalProduct.specialDesignation.identifier",
"path" : "MedicinalProduct.specialDesignation.identifier",
"short" : "Identifier for the designation, or procedure number",
"definition" : "Identifier for the designation, or procedure number.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicinalProduct.specialDesignation.identifier",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Identifier"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProduct.specialDesignation.type",
"path" : "MedicinalProduct.specialDesignation.type",
"short" : "The type of special designation, e.g. orphan drug, minor use",
"definition" : "The type of special designation, e.g. orphan drug, minor use.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicinalProduct.specialDesignation.type",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProduct.specialDesignation.intendedUse",
"path" : "MedicinalProduct.specialDesignation.intendedUse",
"short" : "The intended use of the product, e.g. prevention, treatment",
"definition" : "The intended use of the product, e.g. prevention, treatment.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicinalProduct.specialDesignation.intendedUse",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProduct.specialDesignation.indication[x]",
"path" : "MedicinalProduct.specialDesignation.indication[x]",
"short" : "Condition for which the medicinal use applies",
"definition" : "Condition for which the medicinal use applies.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicinalProduct.specialDesignation.indication[x]",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
},
{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/MedicinalProductIndication"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProduct.specialDesignation.status",
"path" : "MedicinalProduct.specialDesignation.status",
"short" : "For example granted, pending, expired or withdrawn",
"definition" : "For example granted, pending, expired or withdrawn.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicinalProduct.specialDesignation.status",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProduct.specialDesignation.date",
"path" : "MedicinalProduct.specialDesignation.date",
"short" : "Date when the designation was granted",
"definition" : "Date when the designation was granted.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicinalProduct.specialDesignation.date",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProduct.specialDesignation.species",
"path" : "MedicinalProduct.specialDesignation.species",
"short" : "Animal species for which this applies",
"definition" : "Animal species for which this applies.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicinalProduct.specialDesignation.species",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
}]
},
"differential" : {
"element" : [{
"id" : "MedicinalProduct",
"path" : "MedicinalProduct",
"short" : "Detailed definition of a medicinal product, typically for uses other than direct patient care (e.g. regulatory use)",
"definition" : "Detailed definition of a medicinal product, typically for uses other than direct patient care (e.g. regulatory use).",
"min" : 0,
"max" : "*"
},
{
"id" : "MedicinalProduct.identifier",
"path" : "MedicinalProduct.identifier",
"short" : "Business identifier for this product. Could be an MPID",
"definition" : "Business identifier for this product. Could be an MPID.",
"alias" : ["MPID"],
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Identifier"
}],
"isSummary" : true
},
{
"id" : "MedicinalProduct.type",
"path" : "MedicinalProduct.type",
"short" : "Regulatory type, e.g. Investigational or Authorized",
"definition" : "Regulatory type, e.g. Investigational or Authorized.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "MedicinalProduct.domain",
"path" : "MedicinalProduct.domain",
"short" : "If this medicine applies to human or veterinary uses",
"definition" : "If this medicine applies to human or veterinary uses.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Coding"
}],
"isSummary" : true
},
{
"id" : "MedicinalProduct.combinedPharmaceuticalDoseForm",
"path" : "MedicinalProduct.combinedPharmaceuticalDoseForm",
"short" : "The dose form for a single part product, or combined form of a multiple part product",
"definition" : "The dose form for a single part product, or combined form of a multiple part product.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "MedicinalProduct.legalStatusOfSupply",
"path" : "MedicinalProduct.legalStatusOfSupply",
"short" : "The legal status of supply of the medicinal product as classified by the regulator",
"definition" : "The legal status of supply of the medicinal product as classified by the regulator.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "MedicinalProduct.additionalMonitoringIndicator",
"path" : "MedicinalProduct.additionalMonitoringIndicator",
"short" : "Whether the Medicinal Product is subject to additional monitoring for regulatory reasons",
"definition" : "Whether the Medicinal Product is subject to additional monitoring for regulatory reasons.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "MedicinalProduct.specialMeasures",
"path" : "MedicinalProduct.specialMeasures",
"short" : "Whether the Medicinal Product is subject to special measures for regulatory reasons",
"definition" : "Whether the Medicinal Product is subject to special measures for regulatory reasons.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "MedicinalProduct.paediatricUseIndicator",
"path" : "MedicinalProduct.paediatricUseIndicator",
"short" : "If authorised for use in children",
"definition" : "If authorised for use in children.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "MedicinalProduct.productClassification",
"path" : "MedicinalProduct.productClassification",
"short" : "Allows the product to be classified by various systems",
"definition" : "Allows the product to be classified by various systems.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "MedicinalProduct.marketingStatus",
"path" : "MedicinalProduct.marketingStatus",
"short" : "Marketing status of the medicinal product, in contrast to marketing authorizaton",
"definition" : "Marketing status of the medicinal product, in contrast to marketing authorizaton.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "MarketingStatus"
}],
"isSummary" : true
},
{
"id" : "MedicinalProduct.pharmaceuticalProduct",
"path" : "MedicinalProduct.pharmaceuticalProduct",
"short" : "Pharmaceutical aspects of product",
"definition" : "Pharmaceutical aspects of product.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/MedicinalProductPharmaceutical"]
}],
"isSummary" : true
},
{
"id" : "MedicinalProduct.packagedMedicinalProduct",
"path" : "MedicinalProduct.packagedMedicinalProduct",
"short" : "Package representation for the product",
"definition" : "Package representation for the product.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/MedicinalProductPackaged"]
}],
"isSummary" : true
},
{
"id" : "MedicinalProduct.attachedDocument",
"path" : "MedicinalProduct.attachedDocument",
"short" : "Supporting documentation, typically for regulatory submission",
"definition" : "Supporting documentation, typically for regulatory submission.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/DocumentReference"]
}],
"isSummary" : true
},
{
"id" : "MedicinalProduct.masterFile",
"path" : "MedicinalProduct.masterFile",
"short" : "A master file for to the medicinal product (e.g. Pharmacovigilance System Master File)",
"definition" : "A master file for to the medicinal product (e.g. Pharmacovigilance System Master File).",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/DocumentReference"]
}],
"isSummary" : true
},
{
"id" : "MedicinalProduct.contact",
"path" : "MedicinalProduct.contact",
"short" : "A product specific contact, person (in a role), or an organization",
"definition" : "A product specific contact, person (in a role), or an organization.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole"]
}],
"isSummary" : true
},
{
"id" : "MedicinalProduct.clinicalTrial",
"path" : "MedicinalProduct.clinicalTrial",
"short" : "Clinical trials or studies that this product is involved in",
"definition" : "Clinical trials or studies that this product is involved in.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ResearchStudy"]
}],
"isSummary" : true
},
{
"id" : "MedicinalProduct.name",
"path" : "MedicinalProduct.name",
"short" : "The product's name, including full name and possibly coded parts",
"definition" : "The product's name, including full name and possibly coded parts.",
"min" : 1,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"isSummary" : true
},
{
"id" : "MedicinalProduct.name.productName",
"path" : "MedicinalProduct.name.productName",
"short" : "The full product name",
"definition" : "The full product name.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "MedicinalProduct.name.namePart",
"path" : "MedicinalProduct.name.namePart",
"short" : "Coding words or phrases of the name",
"definition" : "Coding words or phrases of the name.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"isSummary" : true
},
{
"id" : "MedicinalProduct.name.namePart.part",
"path" : "MedicinalProduct.name.namePart.part",
"short" : "A fragment of a product name",
"definition" : "A fragment of a product name.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "MedicinalProduct.name.namePart.type",
"path" : "MedicinalProduct.name.namePart.type",
"short" : "Idenifying type for this part of the name (e.g. strength part)",
"definition" : "Idenifying type for this part of the name (e.g. strength part).",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "Coding"
}],
"isSummary" : true
},
{
"id" : "MedicinalProduct.name.countryLanguage",
"path" : "MedicinalProduct.name.countryLanguage",
"short" : "Country where the name applies",
"definition" : "Country where the name applies.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"isSummary" : true
},
{
"id" : "MedicinalProduct.name.countryLanguage.country",
"path" : "MedicinalProduct.name.countryLanguage.country",
"short" : "Country code for where this name applies",
"definition" : "Country code for where this name applies.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "MedicinalProduct.name.countryLanguage.jurisdiction",
"path" : "MedicinalProduct.name.countryLanguage.jurisdiction",
"short" : "Jurisdiction code for where this name applies",
"definition" : "Jurisdiction code for where this name applies.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "MedicinalProduct.name.countryLanguage.language",
"path" : "MedicinalProduct.name.countryLanguage.language",
"short" : "Language code for this name",
"definition" : "Language code for this name.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "MedicinalProduct.crossReference",
"path" : "MedicinalProduct.crossReference",
"short" : "Reference to another product, e.g. for linking authorised to investigational product",
"definition" : "Reference to another product, e.g. for linking authorised to investigational product.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Identifier"
}],
"isSummary" : true
},
{
"id" : "MedicinalProduct.manufacturingBusinessOperation",
"path" : "MedicinalProduct.manufacturingBusinessOperation",
"short" : "An operation applied to the product, for manufacturing or adminsitrative purpose",
"definition" : "An operation applied to the product, for manufacturing or adminsitrative purpose.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"isSummary" : true
},
{
"id" : "MedicinalProduct.manufacturingBusinessOperation.operationType",
"path" : "MedicinalProduct.manufacturingBusinessOperation.operationType",
"short" : "The type of manufacturing operation",
"definition" : "The type of manufacturing operation.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "MedicinalProduct.manufacturingBusinessOperation.authorisationReferenceNumber",
"path" : "MedicinalProduct.manufacturingBusinessOperation.authorisationReferenceNumber",
"short" : "Regulatory authorization reference number",
"definition" : "Regulatory authorization reference number.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Identifier"
}],
"isSummary" : true
},
{
"id" : "MedicinalProduct.manufacturingBusinessOperation.effectiveDate",
"path" : "MedicinalProduct.manufacturingBusinessOperation.effectiveDate",
"short" : "Regulatory authorization date",
"definition" : "Regulatory authorization date.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "dateTime"
}],
"isSummary" : true
},
{
"id" : "MedicinalProduct.manufacturingBusinessOperation.confidentialityIndicator",
"path" : "MedicinalProduct.manufacturingBusinessOperation.confidentialityIndicator",
"short" : "To indicate if this proces is commercially confidential",
"definition" : "To indicate if this proces is commercially confidential.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "MedicinalProduct.manufacturingBusinessOperation.manufacturer",
"path" : "MedicinalProduct.manufacturingBusinessOperation.manufacturer",
"short" : "The manufacturer or establishment associated with the process",
"definition" : "The manufacturer or establishment associated with the process.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"isSummary" : true
},
{
"id" : "MedicinalProduct.manufacturingBusinessOperation.regulator",
"path" : "MedicinalProduct.manufacturingBusinessOperation.regulator",
"short" : "A regulator which oversees the operation",
"definition" : "A regulator which oversees the operation.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"isSummary" : true
},
{
"id" : "MedicinalProduct.specialDesignation",
"path" : "MedicinalProduct.specialDesignation",
"short" : "Indicates if the medicinal product has an orphan designation for the treatment of a rare disease",
"definition" : "Indicates if the medicinal product has an orphan designation for the treatment of a rare disease.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"isSummary" : true
},
{
"id" : "MedicinalProduct.specialDesignation.identifier",
"path" : "MedicinalProduct.specialDesignation.identifier",
"short" : "Identifier for the designation, or procedure number",
"definition" : "Identifier for the designation, or procedure number.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Identifier"
}],
"isSummary" : true
},
{
"id" : "MedicinalProduct.specialDesignation.type",
"path" : "MedicinalProduct.specialDesignation.type",
"short" : "The type of special designation, e.g. orphan drug, minor use",
"definition" : "The type of special designation, e.g. orphan drug, minor use.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "MedicinalProduct.specialDesignation.intendedUse",
"path" : "MedicinalProduct.specialDesignation.intendedUse",
"short" : "The intended use of the product, e.g. prevention, treatment",
"definition" : "The intended use of the product, e.g. prevention, treatment.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "MedicinalProduct.specialDesignation.indication[x]",
"path" : "MedicinalProduct.specialDesignation.indication[x]",
"short" : "Condition for which the medicinal use applies",
"definition" : "Condition for which the medicinal use applies.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
},
{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/MedicinalProductIndication"]
}],
"isSummary" : true
},
{
"id" : "MedicinalProduct.specialDesignation.status",
"path" : "MedicinalProduct.specialDesignation.status",
"short" : "For example granted, pending, expired or withdrawn",
"definition" : "For example granted, pending, expired or withdrawn.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "MedicinalProduct.specialDesignation.date",
"path" : "MedicinalProduct.specialDesignation.date",
"short" : "Date when the designation was granted",
"definition" : "Date when the designation was granted.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "dateTime"
}],
"isSummary" : true
},
{
"id" : "MedicinalProduct.specialDesignation.species",
"path" : "MedicinalProduct.specialDesignation.species",
"short" : "Animal species for which this applies",
"definition" : "Animal species for which this applies.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
}]
}
}
},
{
"fullUrl" : "http://hl7.org/fhir/StructureDefinition/MedicinalProductAuthorization",
"resource" : {
"resourceType" : "StructureDefinition",
"id" : "MedicinalProductAuthorization",
"meta" : {
"lastUpdated" : "2019-11-01T09:29:23.356+11:00"
},
"text" : {
"status" : "generated",
"div" : "Name Flags Card. Type Description & Constraints MedicinalProductAuthorization ΣTU DomainResource The regulatory authorization of a medicinal product
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension identifier Σ 0..* Identifier Business identifier for the marketing authorization, as assigned by a regulator
subject Σ 0..1 Reference(MedicinalProduct | MedicinalProductPackaged) The medicinal product that is being authorized country Σ 0..* CodeableConcept The country in which the marketing authorization has been granted
jurisdiction Σ 0..* CodeableConcept Jurisdiction within a country
status Σ 0..1 CodeableConcept The status of the marketing authorization statusDate Σ 0..1 dateTime The date at which the given status has become applicable restoreDate Σ 0..1 dateTime The date when a suspended the marketing or the marketing authorization of the product is anticipated to be restored validityPeriod Σ 0..1 Period The beginning of the time period in which the marketing authorization is in the specific status shall be specified A complete date consisting of day, month and year shall be specified using the ISO 8601 date format dataExclusivityPeriod Σ 0..1 Period A period of time after authorization before generic product applicatiosn can be submitted dateOfFirstAuthorization Σ 0..1 dateTime The date when the first authorization was granted by a Medicines Regulatory Agency internationalBirthDate Σ 0..1 dateTime Date of first marketing authorization for a company's new medicinal product in any country in the World legalBasis Σ 0..1 CodeableConcept The legal framework against which this authorization is granted jurisdictionalAuthorization Σ 0..* BackboneElement Authorization in areas within a country
identifier Σ 0..* Identifier The assigned number for the marketing authorization
country Σ 0..1 CodeableConcept Country of authorization jurisdiction Σ 0..* CodeableConcept Jurisdiction within a country
legalStatusOfSupply Σ 0..1 CodeableConcept The legal status of supply in a jurisdiction or region validityPeriod Σ 0..1 Period The start and expected end date of the authorization holder Σ 0..1 Reference(Organization) Marketing Authorization Holder regulator Σ 0..1 Reference(Organization) Medicines Regulatory Agency procedure Σ 0..1 BackboneElement The regulatory procedure for granting or amending a marketing authorization identifier Σ 0..1 Identifier Identifier for this procedure type Σ 1..1 CodeableConcept Type of procedure date[x] Σ 0..1 Date of procedure datePeriod Period dateDateTime dateTime application Σ 0..* see procedure Applcations submitted to obtain a marketing authorization
Documentation for this format
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Specialized.Medication Definition"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 0
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "anonymous"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "brr"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/MedicinalProductAuthorization",
"version" : "4.0.1",
"name" : "MedicinalProductAuthorization",
"status" : "draft",
"date" : "2019-11-01T09:29:23+11:00",
"publisher" : "Health Level Seven International (Biomedical Research and Regulation)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/rcrim/index.cfm"
}]
}],
"description" : "The regulatory authorization of a medicinal product.",
"fhirVersion" : "4.0.1",
"mapping" : [{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
}],
"kind" : "resource",
"abstract" : false,
"type" : "MedicinalProductAuthorization",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "MedicinalProductAuthorization",
"path" : "MedicinalProductAuthorization",
"short" : "The regulatory authorization of a medicinal product",
"definition" : "The regulatory authorization of a medicinal product.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicinalProductAuthorization",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "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",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.`div`.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
}]
},
{
"id" : "MedicinalProductAuthorization.id",
"path" : "MedicinalProductAuthorization.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductAuthorization.meta",
"path" : "MedicinalProductAuthorization.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductAuthorization.implicitRules",
"path" : "MedicinalProductAuthorization.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "MedicinalProductAuthorization.language",
"path" : "MedicinalProductAuthorization.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "MedicinalProductAuthorization.text",
"path" : "MedicinalProductAuthorization.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "MedicinalProductAuthorization.contained",
"path" : "MedicinalProductAuthorization.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MedicinalProductAuthorization.extension",
"path" : "MedicinalProductAuthorization.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MedicinalProductAuthorization.modifierExtension",
"path" : "MedicinalProductAuthorization.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MedicinalProductAuthorization.identifier",
"path" : "MedicinalProductAuthorization.identifier",
"short" : "Business identifier for the marketing authorization, as assigned by a regulator",
"definition" : "Business identifier for the marketing authorization, as assigned by a regulator.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicinalProductAuthorization.identifier",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Identifier"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductAuthorization.subject",
"path" : "MedicinalProductAuthorization.subject",
"short" : "The medicinal product that is being authorized",
"definition" : "The medicinal product that is being authorized.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicinalProductAuthorization.subject",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/MedicinalProduct",
"http://hl7.org/fhir/StructureDefinition/MedicinalProductPackaged"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductAuthorization.country",
"path" : "MedicinalProductAuthorization.country",
"short" : "The country in which the marketing authorization has been granted",
"definition" : "The country in which the marketing authorization has been granted.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicinalProductAuthorization.country",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductAuthorization.jurisdiction",
"path" : "MedicinalProductAuthorization.jurisdiction",
"short" : "Jurisdiction within a country",
"definition" : "Jurisdiction within a country.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicinalProductAuthorization.jurisdiction",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductAuthorization.status",
"path" : "MedicinalProductAuthorization.status",
"short" : "The status of the marketing authorization",
"definition" : "The status of the marketing authorization.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicinalProductAuthorization.status",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductAuthorization.statusDate",
"path" : "MedicinalProductAuthorization.statusDate",
"short" : "The date at which the given status has become applicable",
"definition" : "The date at which the given status has become applicable.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicinalProductAuthorization.statusDate",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductAuthorization.restoreDate",
"path" : "MedicinalProductAuthorization.restoreDate",
"short" : "The date when a suspended the marketing or the marketing authorization of the product is anticipated to be restored",
"definition" : "The date when a suspended the marketing or the marketing authorization of the product is anticipated to be restored.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicinalProductAuthorization.restoreDate",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductAuthorization.validityPeriod",
"path" : "MedicinalProductAuthorization.validityPeriod",
"short" : "The beginning of the time period in which the marketing authorization is in the specific status shall be specified A complete date consisting of day, month and year shall be specified using the ISO 8601 date format",
"definition" : "The beginning of the time period in which the marketing authorization is in the specific status shall be specified A complete date consisting of day, month and year shall be specified using the ISO 8601 date format.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicinalProductAuthorization.validityPeriod",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Period"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductAuthorization.dataExclusivityPeriod",
"path" : "MedicinalProductAuthorization.dataExclusivityPeriod",
"short" : "A period of time after authorization before generic product applicatiosn can be submitted",
"definition" : "A period of time after authorization before generic product applicatiosn can be submitted.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicinalProductAuthorization.dataExclusivityPeriod",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Period"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductAuthorization.dateOfFirstAuthorization",
"path" : "MedicinalProductAuthorization.dateOfFirstAuthorization",
"short" : "The date when the first authorization was granted by a Medicines Regulatory Agency",
"definition" : "The date when the first authorization was granted by a Medicines Regulatory Agency.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicinalProductAuthorization.dateOfFirstAuthorization",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductAuthorization.internationalBirthDate",
"path" : "MedicinalProductAuthorization.internationalBirthDate",
"short" : "Date of first marketing authorization for a company's new medicinal product in any country in the World",
"definition" : "Date of first marketing authorization for a company's new medicinal product in any country in the World.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicinalProductAuthorization.internationalBirthDate",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductAuthorization.legalBasis",
"path" : "MedicinalProductAuthorization.legalBasis",
"short" : "The legal framework against which this authorization is granted",
"definition" : "The legal framework against which this authorization is granted.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicinalProductAuthorization.legalBasis",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductAuthorization.jurisdictionalAuthorization",
"path" : "MedicinalProductAuthorization.jurisdictionalAuthorization",
"short" : "Authorization in areas within a country",
"definition" : "Authorization in areas within a country.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicinalProductAuthorization.jurisdictionalAuthorization",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductAuthorization.jurisdictionalAuthorization.id",
"path" : "MedicinalProductAuthorization.jurisdictionalAuthorization.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MedicinalProductAuthorization.jurisdictionalAuthorization.extension",
"path" : "MedicinalProductAuthorization.jurisdictionalAuthorization.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MedicinalProductAuthorization.jurisdictionalAuthorization.modifierExtension",
"path" : "MedicinalProductAuthorization.jurisdictionalAuthorization.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MedicinalProductAuthorization.jurisdictionalAuthorization.identifier",
"path" : "MedicinalProductAuthorization.jurisdictionalAuthorization.identifier",
"short" : "The assigned number for the marketing authorization",
"definition" : "The assigned number for the marketing authorization.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicinalProductAuthorization.jurisdictionalAuthorization.identifier",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Identifier"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductAuthorization.jurisdictionalAuthorization.country",
"path" : "MedicinalProductAuthorization.jurisdictionalAuthorization.country",
"short" : "Country of authorization",
"definition" : "Country of authorization.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicinalProductAuthorization.jurisdictionalAuthorization.country",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductAuthorization.jurisdictionalAuthorization.jurisdiction",
"path" : "MedicinalProductAuthorization.jurisdictionalAuthorization.jurisdiction",
"short" : "Jurisdiction within a country",
"definition" : "Jurisdiction within a country.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicinalProductAuthorization.jurisdictionalAuthorization.jurisdiction",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductAuthorization.jurisdictionalAuthorization.legalStatusOfSupply",
"path" : "MedicinalProductAuthorization.jurisdictionalAuthorization.legalStatusOfSupply",
"short" : "The legal status of supply in a jurisdiction or region",
"definition" : "The legal status of supply in a jurisdiction or region.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicinalProductAuthorization.jurisdictionalAuthorization.legalStatusOfSupply",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductAuthorization.jurisdictionalAuthorization.validityPeriod",
"path" : "MedicinalProductAuthorization.jurisdictionalAuthorization.validityPeriod",
"short" : "The start and expected end date of the authorization",
"definition" : "The start and expected end date of the authorization.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicinalProductAuthorization.jurisdictionalAuthorization.validityPeriod",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Period"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductAuthorization.holder",
"path" : "MedicinalProductAuthorization.holder",
"short" : "Marketing Authorization Holder",
"definition" : "Marketing Authorization Holder.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicinalProductAuthorization.holder",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductAuthorization.regulator",
"path" : "MedicinalProductAuthorization.regulator",
"short" : "Medicines Regulatory Agency",
"definition" : "Medicines Regulatory Agency.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicinalProductAuthorization.regulator",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductAuthorization.procedure",
"path" : "MedicinalProductAuthorization.procedure",
"short" : "The regulatory procedure for granting or amending a marketing authorization",
"definition" : "The regulatory procedure for granting or amending a marketing authorization.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicinalProductAuthorization.procedure",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductAuthorization.procedure.id",
"path" : "MedicinalProductAuthorization.procedure.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MedicinalProductAuthorization.procedure.extension",
"path" : "MedicinalProductAuthorization.procedure.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MedicinalProductAuthorization.procedure.modifierExtension",
"path" : "MedicinalProductAuthorization.procedure.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MedicinalProductAuthorization.procedure.identifier",
"path" : "MedicinalProductAuthorization.procedure.identifier",
"short" : "Identifier for this procedure",
"definition" : "Identifier for this procedure.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicinalProductAuthorization.procedure.identifier",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Identifier"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductAuthorization.procedure.type",
"path" : "MedicinalProductAuthorization.procedure.type",
"short" : "Type of procedure",
"definition" : "Type of procedure.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "MedicinalProductAuthorization.procedure.type",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductAuthorization.procedure.date[x]",
"path" : "MedicinalProductAuthorization.procedure.date[x]",
"short" : "Date of procedure",
"definition" : "Date of procedure.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicinalProductAuthorization.procedure.date[x]",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Period"
},
{
"code" : "dateTime"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductAuthorization.procedure.application",
"path" : "MedicinalProductAuthorization.procedure.application",
"short" : "Applcations submitted to obtain a marketing authorization",
"definition" : "Applcations submitted to obtain a marketing authorization.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicinalProductAuthorization.procedure.application",
"min" : 0,
"max" : "*"
},
"contentReference" : "#MedicinalProductAuthorization.procedure",
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
}]
},
"differential" : {
"element" : [{
"id" : "MedicinalProductAuthorization",
"path" : "MedicinalProductAuthorization",
"short" : "The regulatory authorization of a medicinal product",
"definition" : "The regulatory authorization of a medicinal product.",
"min" : 0,
"max" : "*"
},
{
"id" : "MedicinalProductAuthorization.identifier",
"path" : "MedicinalProductAuthorization.identifier",
"short" : "Business identifier for the marketing authorization, as assigned by a regulator",
"definition" : "Business identifier for the marketing authorization, as assigned by a regulator.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Identifier"
}],
"isSummary" : true
},
{
"id" : "MedicinalProductAuthorization.subject",
"path" : "MedicinalProductAuthorization.subject",
"short" : "The medicinal product that is being authorized",
"definition" : "The medicinal product that is being authorized.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/MedicinalProduct",
"http://hl7.org/fhir/StructureDefinition/MedicinalProductPackaged"]
}],
"isSummary" : true
},
{
"id" : "MedicinalProductAuthorization.country",
"path" : "MedicinalProductAuthorization.country",
"short" : "The country in which the marketing authorization has been granted",
"definition" : "The country in which the marketing authorization has been granted.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "MedicinalProductAuthorization.jurisdiction",
"path" : "MedicinalProductAuthorization.jurisdiction",
"short" : "Jurisdiction within a country",
"definition" : "Jurisdiction within a country.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "MedicinalProductAuthorization.status",
"path" : "MedicinalProductAuthorization.status",
"short" : "The status of the marketing authorization",
"definition" : "The status of the marketing authorization.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "MedicinalProductAuthorization.statusDate",
"path" : "MedicinalProductAuthorization.statusDate",
"short" : "The date at which the given status has become applicable",
"definition" : "The date at which the given status has become applicable.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "dateTime"
}],
"isSummary" : true
},
{
"id" : "MedicinalProductAuthorization.restoreDate",
"path" : "MedicinalProductAuthorization.restoreDate",
"short" : "The date when a suspended the marketing or the marketing authorization of the product is anticipated to be restored",
"definition" : "The date when a suspended the marketing or the marketing authorization of the product is anticipated to be restored.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "dateTime"
}],
"isSummary" : true
},
{
"id" : "MedicinalProductAuthorization.validityPeriod",
"path" : "MedicinalProductAuthorization.validityPeriod",
"short" : "The beginning of the time period in which the marketing authorization is in the specific status shall be specified A complete date consisting of day, month and year shall be specified using the ISO 8601 date format",
"definition" : "The beginning of the time period in which the marketing authorization is in the specific status shall be specified A complete date consisting of day, month and year shall be specified using the ISO 8601 date format.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Period"
}],
"isSummary" : true
},
{
"id" : "MedicinalProductAuthorization.dataExclusivityPeriod",
"path" : "MedicinalProductAuthorization.dataExclusivityPeriod",
"short" : "A period of time after authorization before generic product applicatiosn can be submitted",
"definition" : "A period of time after authorization before generic product applicatiosn can be submitted.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Period"
}],
"isSummary" : true
},
{
"id" : "MedicinalProductAuthorization.dateOfFirstAuthorization",
"path" : "MedicinalProductAuthorization.dateOfFirstAuthorization",
"short" : "The date when the first authorization was granted by a Medicines Regulatory Agency",
"definition" : "The date when the first authorization was granted by a Medicines Regulatory Agency.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "dateTime"
}],
"isSummary" : true
},
{
"id" : "MedicinalProductAuthorization.internationalBirthDate",
"path" : "MedicinalProductAuthorization.internationalBirthDate",
"short" : "Date of first marketing authorization for a company's new medicinal product in any country in the World",
"definition" : "Date of first marketing authorization for a company's new medicinal product in any country in the World.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "dateTime"
}],
"isSummary" : true
},
{
"id" : "MedicinalProductAuthorization.legalBasis",
"path" : "MedicinalProductAuthorization.legalBasis",
"short" : "The legal framework against which this authorization is granted",
"definition" : "The legal framework against which this authorization is granted.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "MedicinalProductAuthorization.jurisdictionalAuthorization",
"path" : "MedicinalProductAuthorization.jurisdictionalAuthorization",
"short" : "Authorization in areas within a country",
"definition" : "Authorization in areas within a country.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"isSummary" : true
},
{
"id" : "MedicinalProductAuthorization.jurisdictionalAuthorization.identifier",
"path" : "MedicinalProductAuthorization.jurisdictionalAuthorization.identifier",
"short" : "The assigned number for the marketing authorization",
"definition" : "The assigned number for the marketing authorization.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Identifier"
}],
"isSummary" : true
},
{
"id" : "MedicinalProductAuthorization.jurisdictionalAuthorization.country",
"path" : "MedicinalProductAuthorization.jurisdictionalAuthorization.country",
"short" : "Country of authorization",
"definition" : "Country of authorization.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "MedicinalProductAuthorization.jurisdictionalAuthorization.jurisdiction",
"path" : "MedicinalProductAuthorization.jurisdictionalAuthorization.jurisdiction",
"short" : "Jurisdiction within a country",
"definition" : "Jurisdiction within a country.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "MedicinalProductAuthorization.jurisdictionalAuthorization.legalStatusOfSupply",
"path" : "MedicinalProductAuthorization.jurisdictionalAuthorization.legalStatusOfSupply",
"short" : "The legal status of supply in a jurisdiction or region",
"definition" : "The legal status of supply in a jurisdiction or region.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "MedicinalProductAuthorization.jurisdictionalAuthorization.validityPeriod",
"path" : "MedicinalProductAuthorization.jurisdictionalAuthorization.validityPeriod",
"short" : "The start and expected end date of the authorization",
"definition" : "The start and expected end date of the authorization.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Period"
}],
"isSummary" : true
},
{
"id" : "MedicinalProductAuthorization.holder",
"path" : "MedicinalProductAuthorization.holder",
"short" : "Marketing Authorization Holder",
"definition" : "Marketing Authorization Holder.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"isSummary" : true
},
{
"id" : "MedicinalProductAuthorization.regulator",
"path" : "MedicinalProductAuthorization.regulator",
"short" : "Medicines Regulatory Agency",
"definition" : "Medicines Regulatory Agency.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"isSummary" : true
},
{
"id" : "MedicinalProductAuthorization.procedure",
"path" : "MedicinalProductAuthorization.procedure",
"short" : "The regulatory procedure for granting or amending a marketing authorization",
"definition" : "The regulatory procedure for granting or amending a marketing authorization.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "BackboneElement"
}],
"isSummary" : true
},
{
"id" : "MedicinalProductAuthorization.procedure.identifier",
"path" : "MedicinalProductAuthorization.procedure.identifier",
"short" : "Identifier for this procedure",
"definition" : "Identifier for this procedure.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Identifier"
}],
"isSummary" : true
},
{
"id" : "MedicinalProductAuthorization.procedure.type",
"path" : "MedicinalProductAuthorization.procedure.type",
"short" : "Type of procedure",
"definition" : "Type of procedure.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "MedicinalProductAuthorization.procedure.date[x]",
"path" : "MedicinalProductAuthorization.procedure.date[x]",
"short" : "Date of procedure",
"definition" : "Date of procedure.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Period"
},
{
"code" : "dateTime"
}],
"isSummary" : true
},
{
"id" : "MedicinalProductAuthorization.procedure.application",
"path" : "MedicinalProductAuthorization.procedure.application",
"short" : "Applcations submitted to obtain a marketing authorization",
"definition" : "Applcations submitted to obtain a marketing authorization.",
"min" : 0,
"max" : "*",
"contentReference" : "#MedicinalProductAuthorization.procedure",
"isSummary" : true
}]
}
}
},
{
"fullUrl" : "http://hl7.org/fhir/StructureDefinition/MedicinalProductContraindication",
"resource" : {
"resourceType" : "StructureDefinition",
"id" : "MedicinalProductContraindication",
"meta" : {
"lastUpdated" : "2019-11-01T09:29:23.356+11:00"
},
"text" : {
"status" : "generated",
"div" : "Name Flags Card. Type Description & Constraints MedicinalProductContraindication ΣTU DomainResource MedicinalProductContraindication
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension subject Σ 0..* Reference(MedicinalProduct | Medication) The medication for which this is an indication
disease Σ 0..1 CodeableConcept The disease, symptom or procedure for the contraindication diseaseStatus Σ 0..1 CodeableConcept The status of the disease or symptom for the contraindication comorbidity Σ 0..* CodeableConcept A comorbidity (concurrent condition) or coinfection
therapeuticIndication Σ 0..* Reference(MedicinalProductIndication) Information about the use of the medicinal product in relation to other therapies as part of the indication
otherTherapy Σ 0..* BackboneElement Information about the use of the medicinal product in relation to other therapies described as part of the indication
therapyRelationshipType Σ 1..1 CodeableConcept The type of relationship between the medicinal product indication or contraindication and another therapy medication[x] Σ 1..1 Reference to a specific medication (active substance, medicinal product or class of products) as part of an indication or contraindication medicationCodeableConcept CodeableConcept medicationReference Reference(MedicinalProduct | Medication | Substance | SubstanceSpecification) population Σ 0..* Population The population group to which this applies
Documentation for this format
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Specialized.Medication Definition"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 0
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "anonymous"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "brr"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/MedicinalProductContraindication",
"version" : "4.0.1",
"name" : "MedicinalProductContraindication",
"status" : "draft",
"date" : "2019-11-01T09:29:23+11:00",
"publisher" : "Health Level Seven International (Biomedical Research and Regulation)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/rcrim/index.cfm"
}]
}],
"description" : "The clinical particulars - indications, contraindications etc. of a medicinal product, including for regulatory purposes.",
"fhirVersion" : "4.0.1",
"mapping" : [{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
}],
"kind" : "resource",
"abstract" : false,
"type" : "MedicinalProductContraindication",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "MedicinalProductContraindication",
"path" : "MedicinalProductContraindication",
"short" : "MedicinalProductContraindication",
"definition" : "The clinical particulars - indications, contraindications etc. of a medicinal product, including for regulatory purposes.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicinalProductContraindication",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "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",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.`div`.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
}]
},
{
"id" : "MedicinalProductContraindication.id",
"path" : "MedicinalProductContraindication.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductContraindication.meta",
"path" : "MedicinalProductContraindication.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductContraindication.implicitRules",
"path" : "MedicinalProductContraindication.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "MedicinalProductContraindication.language",
"path" : "MedicinalProductContraindication.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "MedicinalProductContraindication.text",
"path" : "MedicinalProductContraindication.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "MedicinalProductContraindication.contained",
"path" : "MedicinalProductContraindication.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MedicinalProductContraindication.extension",
"path" : "MedicinalProductContraindication.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MedicinalProductContraindication.modifierExtension",
"path" : "MedicinalProductContraindication.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MedicinalProductContraindication.subject",
"path" : "MedicinalProductContraindication.subject",
"short" : "The medication for which this is an indication",
"definition" : "The medication for which this is an indication.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicinalProductContraindication.subject",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/MedicinalProduct",
"http://hl7.org/fhir/StructureDefinition/Medication"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductContraindication.disease",
"path" : "MedicinalProductContraindication.disease",
"short" : "The disease, symptom or procedure for the contraindication",
"definition" : "The disease, symptom or procedure for the contraindication.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicinalProductContraindication.disease",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductContraindication.diseaseStatus",
"path" : "MedicinalProductContraindication.diseaseStatus",
"short" : "The status of the disease or symptom for the contraindication",
"definition" : "The status of the disease or symptom for the contraindication.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicinalProductContraindication.diseaseStatus",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductContraindication.comorbidity",
"path" : "MedicinalProductContraindication.comorbidity",
"short" : "A comorbidity (concurrent condition) or coinfection",
"definition" : "A comorbidity (concurrent condition) or coinfection.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicinalProductContraindication.comorbidity",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductContraindication.therapeuticIndication",
"path" : "MedicinalProductContraindication.therapeuticIndication",
"short" : "Information about the use of the medicinal product in relation to other therapies as part of the indication",
"definition" : "Information about the use of the medicinal product in relation to other therapies as part of the indication.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicinalProductContraindication.therapeuticIndication",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/MedicinalProductIndication"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductContraindication.otherTherapy",
"path" : "MedicinalProductContraindication.otherTherapy",
"short" : "Information about the use of the medicinal product in relation to other therapies described as part of the indication",
"definition" : "Information about the use of the medicinal product in relation to other therapies described as part of the indication.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicinalProductContraindication.otherTherapy",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductContraindication.otherTherapy.id",
"path" : "MedicinalProductContraindication.otherTherapy.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MedicinalProductContraindication.otherTherapy.extension",
"path" : "MedicinalProductContraindication.otherTherapy.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MedicinalProductContraindication.otherTherapy.modifierExtension",
"path" : "MedicinalProductContraindication.otherTherapy.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MedicinalProductContraindication.otherTherapy.therapyRelationshipType",
"path" : "MedicinalProductContraindication.otherTherapy.therapyRelationshipType",
"short" : "The type of relationship between the medicinal product indication or contraindication and another therapy",
"definition" : "The type of relationship between the medicinal product indication or contraindication and another therapy.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "MedicinalProductContraindication.otherTherapy.therapyRelationshipType",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductContraindication.otherTherapy.medication[x]",
"path" : "MedicinalProductContraindication.otherTherapy.medication[x]",
"short" : "Reference to a specific medication (active substance, medicinal product or class of products) as part of an indication or contraindication",
"definition" : "Reference to a specific medication (active substance, medicinal product or class of products) as part of an indication or contraindication.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "MedicinalProductContraindication.otherTherapy.medication[x]",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
},
{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/MedicinalProduct",
"http://hl7.org/fhir/StructureDefinition/Medication",
"http://hl7.org/fhir/StructureDefinition/Substance",
"http://hl7.org/fhir/StructureDefinition/SubstanceSpecification"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductContraindication.population",
"path" : "MedicinalProductContraindication.population",
"short" : "The population group to which this applies",
"definition" : "The population group to which this applies.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicinalProductContraindication.population",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Population"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
}]
},
"differential" : {
"element" : [{
"id" : "MedicinalProductContraindication",
"path" : "MedicinalProductContraindication",
"short" : "MedicinalProductContraindication",
"definition" : "The clinical particulars - indications, contraindications etc. of a medicinal product, including for regulatory purposes.",
"min" : 0,
"max" : "*"
},
{
"id" : "MedicinalProductContraindication.subject",
"path" : "MedicinalProductContraindication.subject",
"short" : "The medication for which this is an indication",
"definition" : "The medication for which this is an indication.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/MedicinalProduct",
"http://hl7.org/fhir/StructureDefinition/Medication"]
}],
"isSummary" : true
},
{
"id" : "MedicinalProductContraindication.disease",
"path" : "MedicinalProductContraindication.disease",
"short" : "The disease, symptom or procedure for the contraindication",
"definition" : "The disease, symptom or procedure for the contraindication.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "MedicinalProductContraindication.diseaseStatus",
"path" : "MedicinalProductContraindication.diseaseStatus",
"short" : "The status of the disease or symptom for the contraindication",
"definition" : "The status of the disease or symptom for the contraindication.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "MedicinalProductContraindication.comorbidity",
"path" : "MedicinalProductContraindication.comorbidity",
"short" : "A comorbidity (concurrent condition) or coinfection",
"definition" : "A comorbidity (concurrent condition) or coinfection.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "MedicinalProductContraindication.therapeuticIndication",
"path" : "MedicinalProductContraindication.therapeuticIndication",
"short" : "Information about the use of the medicinal product in relation to other therapies as part of the indication",
"definition" : "Information about the use of the medicinal product in relation to other therapies as part of the indication.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/MedicinalProductIndication"]
}],
"isSummary" : true
},
{
"id" : "MedicinalProductContraindication.otherTherapy",
"path" : "MedicinalProductContraindication.otherTherapy",
"short" : "Information about the use of the medicinal product in relation to other therapies described as part of the indication",
"definition" : "Information about the use of the medicinal product in relation to other therapies described as part of the indication.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"isSummary" : true
},
{
"id" : "MedicinalProductContraindication.otherTherapy.therapyRelationshipType",
"path" : "MedicinalProductContraindication.otherTherapy.therapyRelationshipType",
"short" : "The type of relationship between the medicinal product indication or contraindication and another therapy",
"definition" : "The type of relationship between the medicinal product indication or contraindication and another therapy.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "MedicinalProductContraindication.otherTherapy.medication[x]",
"path" : "MedicinalProductContraindication.otherTherapy.medication[x]",
"short" : "Reference to a specific medication (active substance, medicinal product or class of products) as part of an indication or contraindication",
"definition" : "Reference to a specific medication (active substance, medicinal product or class of products) as part of an indication or contraindication.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
},
{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/MedicinalProduct",
"http://hl7.org/fhir/StructureDefinition/Medication",
"http://hl7.org/fhir/StructureDefinition/Substance",
"http://hl7.org/fhir/StructureDefinition/SubstanceSpecification"]
}],
"isSummary" : true
},
{
"id" : "MedicinalProductContraindication.population",
"path" : "MedicinalProductContraindication.population",
"short" : "The population group to which this applies",
"definition" : "The population group to which this applies.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Population"
}],
"isSummary" : true
}]
}
}
},
{
"fullUrl" : "http://hl7.org/fhir/StructureDefinition/MedicinalProductIndication",
"resource" : {
"resourceType" : "StructureDefinition",
"id" : "MedicinalProductIndication",
"meta" : {
"lastUpdated" : "2019-11-01T09:29:23.356+11:00"
},
"text" : {
"status" : "generated",
"div" : "Name Flags Card. Type Description & Constraints MedicinalProductIndication ΣTU DomainResource MedicinalProductIndication
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension subject Σ 0..* Reference(MedicinalProduct | Medication) The medication for which this is an indication
diseaseSymptomProcedure Σ 0..1 CodeableConcept The disease, symptom or procedure that is the indication for treatment diseaseStatus Σ 0..1 CodeableConcept The status of the disease or symptom for which the indication applies comorbidity Σ 0..* CodeableConcept Comorbidity (concurrent condition) or co-infection as part of the indication
intendedEffect Σ 0..1 CodeableConcept The intended effect, aim or strategy to be achieved by the indication duration Σ 0..1 Quantity Timing or duration information as part of the indication otherTherapy Σ 0..* BackboneElement Information about the use of the medicinal product in relation to other therapies described as part of the indication
therapyRelationshipType Σ 1..1 CodeableConcept The type of relationship between the medicinal product indication or contraindication and another therapy medication[x] Σ 1..1 Reference to a specific medication (active substance, medicinal product or class of products) as part of an indication or contraindication medicationCodeableConcept CodeableConcept medicationReference Reference(MedicinalProduct | Medication | Substance | SubstanceSpecification) undesirableEffect Σ 0..* Reference(MedicinalProductUndesirableEffect) Describe the undesirable effects of the medicinal product
population Σ 0..* Population The population group to which this applies
Documentation for this format
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Specialized.Medication Definition"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 0
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "anonymous"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "brr"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/MedicinalProductIndication",
"version" : "4.0.1",
"name" : "MedicinalProductIndication",
"status" : "draft",
"date" : "2019-11-01T09:29:23+11:00",
"publisher" : "Health Level Seven International (Biomedical Research and Regulation)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/rcrim/index.cfm"
}]
}],
"description" : "Indication for the Medicinal Product.",
"fhirVersion" : "4.0.1",
"mapping" : [{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
}],
"kind" : "resource",
"abstract" : false,
"type" : "MedicinalProductIndication",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "MedicinalProductIndication",
"path" : "MedicinalProductIndication",
"short" : "MedicinalProductIndication",
"definition" : "Indication for the Medicinal Product.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicinalProductIndication",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "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",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.`div`.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
}]
},
{
"id" : "MedicinalProductIndication.id",
"path" : "MedicinalProductIndication.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductIndication.meta",
"path" : "MedicinalProductIndication.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductIndication.implicitRules",
"path" : "MedicinalProductIndication.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "MedicinalProductIndication.language",
"path" : "MedicinalProductIndication.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "MedicinalProductIndication.text",
"path" : "MedicinalProductIndication.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "MedicinalProductIndication.contained",
"path" : "MedicinalProductIndication.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MedicinalProductIndication.extension",
"path" : "MedicinalProductIndication.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MedicinalProductIndication.modifierExtension",
"path" : "MedicinalProductIndication.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MedicinalProductIndication.subject",
"path" : "MedicinalProductIndication.subject",
"short" : "The medication for which this is an indication",
"definition" : "The medication for which this is an indication.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicinalProductIndication.subject",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/MedicinalProduct",
"http://hl7.org/fhir/StructureDefinition/Medication"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductIndication.diseaseSymptomProcedure",
"path" : "MedicinalProductIndication.diseaseSymptomProcedure",
"short" : "The disease, symptom or procedure that is the indication for treatment",
"definition" : "The disease, symptom or procedure that is the indication for treatment.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicinalProductIndication.diseaseSymptomProcedure",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductIndication.diseaseStatus",
"path" : "MedicinalProductIndication.diseaseStatus",
"short" : "The status of the disease or symptom for which the indication applies",
"definition" : "The status of the disease or symptom for which the indication applies.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicinalProductIndication.diseaseStatus",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductIndication.comorbidity",
"path" : "MedicinalProductIndication.comorbidity",
"short" : "Comorbidity (concurrent condition) or co-infection as part of the indication",
"definition" : "Comorbidity (concurrent condition) or co-infection as part of the indication.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicinalProductIndication.comorbidity",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductIndication.intendedEffect",
"path" : "MedicinalProductIndication.intendedEffect",
"short" : "The intended effect, aim or strategy to be achieved by the indication",
"definition" : "The intended effect, aim or strategy to be achieved by the indication.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicinalProductIndication.intendedEffect",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductIndication.duration",
"path" : "MedicinalProductIndication.duration",
"short" : "Timing or duration information as part of the indication",
"definition" : "Timing or duration information as part of the indication.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicinalProductIndication.duration",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Quantity"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductIndication.otherTherapy",
"path" : "MedicinalProductIndication.otherTherapy",
"short" : "Information about the use of the medicinal product in relation to other therapies described as part of the indication",
"definition" : "Information about the use of the medicinal product in relation to other therapies described as part of the indication.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicinalProductIndication.otherTherapy",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductIndication.otherTherapy.id",
"path" : "MedicinalProductIndication.otherTherapy.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MedicinalProductIndication.otherTherapy.extension",
"path" : "MedicinalProductIndication.otherTherapy.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MedicinalProductIndication.otherTherapy.modifierExtension",
"path" : "MedicinalProductIndication.otherTherapy.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MedicinalProductIndication.otherTherapy.therapyRelationshipType",
"path" : "MedicinalProductIndication.otherTherapy.therapyRelationshipType",
"short" : "The type of relationship between the medicinal product indication or contraindication and another therapy",
"definition" : "The type of relationship between the medicinal product indication or contraindication and another therapy.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "MedicinalProductIndication.otherTherapy.therapyRelationshipType",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductIndication.otherTherapy.medication[x]",
"path" : "MedicinalProductIndication.otherTherapy.medication[x]",
"short" : "Reference to a specific medication (active substance, medicinal product or class of products) as part of an indication or contraindication",
"definition" : "Reference to a specific medication (active substance, medicinal product or class of products) as part of an indication or contraindication.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "MedicinalProductIndication.otherTherapy.medication[x]",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
},
{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/MedicinalProduct",
"http://hl7.org/fhir/StructureDefinition/Medication",
"http://hl7.org/fhir/StructureDefinition/Substance",
"http://hl7.org/fhir/StructureDefinition/SubstanceSpecification"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductIndication.undesirableEffect",
"path" : "MedicinalProductIndication.undesirableEffect",
"short" : "Describe the undesirable effects of the medicinal product",
"definition" : "Describe the undesirable effects of the medicinal product.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicinalProductIndication.undesirableEffect",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/MedicinalProductUndesirableEffect"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductIndication.population",
"path" : "MedicinalProductIndication.population",
"short" : "The population group to which this applies",
"definition" : "The population group to which this applies.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicinalProductIndication.population",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Population"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
}]
},
"differential" : {
"element" : [{
"id" : "MedicinalProductIndication",
"path" : "MedicinalProductIndication",
"short" : "MedicinalProductIndication",
"definition" : "Indication for the Medicinal Product.",
"min" : 0,
"max" : "*"
},
{
"id" : "MedicinalProductIndication.subject",
"path" : "MedicinalProductIndication.subject",
"short" : "The medication for which this is an indication",
"definition" : "The medication for which this is an indication.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/MedicinalProduct",
"http://hl7.org/fhir/StructureDefinition/Medication"]
}],
"isSummary" : true
},
{
"id" : "MedicinalProductIndication.diseaseSymptomProcedure",
"path" : "MedicinalProductIndication.diseaseSymptomProcedure",
"short" : "The disease, symptom or procedure that is the indication for treatment",
"definition" : "The disease, symptom or procedure that is the indication for treatment.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "MedicinalProductIndication.diseaseStatus",
"path" : "MedicinalProductIndication.diseaseStatus",
"short" : "The status of the disease or symptom for which the indication applies",
"definition" : "The status of the disease or symptom for which the indication applies.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "MedicinalProductIndication.comorbidity",
"path" : "MedicinalProductIndication.comorbidity",
"short" : "Comorbidity (concurrent condition) or co-infection as part of the indication",
"definition" : "Comorbidity (concurrent condition) or co-infection as part of the indication.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "MedicinalProductIndication.intendedEffect",
"path" : "MedicinalProductIndication.intendedEffect",
"short" : "The intended effect, aim or strategy to be achieved by the indication",
"definition" : "The intended effect, aim or strategy to be achieved by the indication.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "MedicinalProductIndication.duration",
"path" : "MedicinalProductIndication.duration",
"short" : "Timing or duration information as part of the indication",
"definition" : "Timing or duration information as part of the indication.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Quantity"
}],
"isSummary" : true
},
{
"id" : "MedicinalProductIndication.otherTherapy",
"path" : "MedicinalProductIndication.otherTherapy",
"short" : "Information about the use of the medicinal product in relation to other therapies described as part of the indication",
"definition" : "Information about the use of the medicinal product in relation to other therapies described as part of the indication.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"isSummary" : true
},
{
"id" : "MedicinalProductIndication.otherTherapy.therapyRelationshipType",
"path" : "MedicinalProductIndication.otherTherapy.therapyRelationshipType",
"short" : "The type of relationship between the medicinal product indication or contraindication and another therapy",
"definition" : "The type of relationship between the medicinal product indication or contraindication and another therapy.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "MedicinalProductIndication.otherTherapy.medication[x]",
"path" : "MedicinalProductIndication.otherTherapy.medication[x]",
"short" : "Reference to a specific medication (active substance, medicinal product or class of products) as part of an indication or contraindication",
"definition" : "Reference to a specific medication (active substance, medicinal product or class of products) as part of an indication or contraindication.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
},
{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/MedicinalProduct",
"http://hl7.org/fhir/StructureDefinition/Medication",
"http://hl7.org/fhir/StructureDefinition/Substance",
"http://hl7.org/fhir/StructureDefinition/SubstanceSpecification"]
}],
"isSummary" : true
},
{
"id" : "MedicinalProductIndication.undesirableEffect",
"path" : "MedicinalProductIndication.undesirableEffect",
"short" : "Describe the undesirable effects of the medicinal product",
"definition" : "Describe the undesirable effects of the medicinal product.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/MedicinalProductUndesirableEffect"]
}],
"isSummary" : true
},
{
"id" : "MedicinalProductIndication.population",
"path" : "MedicinalProductIndication.population",
"short" : "The population group to which this applies",
"definition" : "The population group to which this applies.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Population"
}],
"isSummary" : true
}]
}
}
},
{
"fullUrl" : "http://hl7.org/fhir/StructureDefinition/MedicinalProductIngredient",
"resource" : {
"resourceType" : "StructureDefinition",
"id" : "MedicinalProductIngredient",
"meta" : {
"lastUpdated" : "2019-11-01T09:29:23.356+11:00"
},
"text" : {
"status" : "generated",
"div" : "Name Flags Card. Type Description & Constraints MedicinalProductIngredient ΣTU DomainResource An ingredient of a manufactured item or pharmaceutical product
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension identifier Σ 0..1 Identifier Identifier for the ingredient role Σ 1..1 CodeableConcept Ingredient role e.g. Active ingredient, excipient allergenicIndicator Σ 0..1 boolean If the ingredient is a known or suspected allergen manufacturer Σ 0..* Reference(Organization) Manufacturer of this Ingredient
specifiedSubstance Σ 0..* BackboneElement A specified substance that comprises this ingredient
code Σ 1..1 CodeableConcept The specified substance group Σ 1..1 CodeableConcept The group of specified substance, e.g. group 1 to 4 confidentiality Σ 0..1 CodeableConcept Confidentiality level of the specified substance as the ingredient strength Σ 0..* BackboneElement Quantity of the substance or specified substance present in the manufactured item or pharmaceutical product
presentation Σ 1..1 Ratio The quantity of substance in the unit of presentation, or in the volume (or mass) of the single pharmaceutical product or manufactured item presentationLowLimit ?!Σ 0..1 Ratio A lower limit for the quantity of substance in the unit of presentation. For use when there is a range of strengths, this is the lower limit, with the presentation attribute becoming the upper limit concentration Σ 0..1 Ratio The strength per unitary volume (or mass) concentrationLowLimit ?!Σ 0..1 Ratio A lower limit for the strength per unitary volume (or mass), for when there is a range. The concentration attribute then becomes the upper limit measurementPoint Σ 0..1 string For when strength is measured at a particular point or distance country Σ 0..* CodeableConcept The country or countries for which the strength range applies
referenceStrength Σ 0..* BackboneElement Strength expressed in terms of a reference substance
substance Σ 0..1 CodeableConcept Relevant reference substance strength Σ 1..1 Ratio Strength expressed in terms of a reference substance strengthLowLimit Σ 0..1 Ratio Strength expressed in terms of a reference substance measurementPoint Σ 0..1 string For when strength is measured at a particular point or distance country Σ 0..* CodeableConcept The country or countries for which the strength range applies
substance Σ 0..1 BackboneElement The ingredient substance code Σ 1..1 CodeableConcept The ingredient substance strength Σ 0..* see strength Quantity of the substance or specified substance present in the manufactured item or pharmaceutical product
Documentation for this format
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Specialized.Medication Definition"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 0
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "anonymous"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "brr"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/MedicinalProductIngredient",
"version" : "4.0.1",
"name" : "MedicinalProductIngredient",
"status" : "draft",
"date" : "2019-11-01T09:29:23+11:00",
"publisher" : "Health Level Seven International (Biomedical Research and Regulation)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/rcrim/index.cfm"
}]
}],
"description" : "An ingredient of a manufactured item or pharmaceutical product.",
"fhirVersion" : "4.0.1",
"mapping" : [{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
}],
"kind" : "resource",
"abstract" : false,
"type" : "MedicinalProductIngredient",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "MedicinalProductIngredient",
"path" : "MedicinalProductIngredient",
"short" : "An ingredient of a manufactured item or pharmaceutical product",
"definition" : "An ingredient of a manufactured item or pharmaceutical product.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicinalProductIngredient",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "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",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.`div`.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
}]
},
{
"id" : "MedicinalProductIngredient.id",
"path" : "MedicinalProductIngredient.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductIngredient.meta",
"path" : "MedicinalProductIngredient.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductIngredient.implicitRules",
"path" : "MedicinalProductIngredient.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "MedicinalProductIngredient.language",
"path" : "MedicinalProductIngredient.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "MedicinalProductIngredient.text",
"path" : "MedicinalProductIngredient.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "MedicinalProductIngredient.contained",
"path" : "MedicinalProductIngredient.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MedicinalProductIngredient.extension",
"path" : "MedicinalProductIngredient.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MedicinalProductIngredient.modifierExtension",
"path" : "MedicinalProductIngredient.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MedicinalProductIngredient.identifier",
"path" : "MedicinalProductIngredient.identifier",
"short" : "Identifier for the ingredient",
"definition" : "The identifier(s) of this Ingredient that are assigned by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicinalProductIngredient.identifier",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Identifier"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductIngredient.role",
"path" : "MedicinalProductIngredient.role",
"short" : "Ingredient role e.g. Active ingredient, excipient",
"definition" : "Ingredient role e.g. Active ingredient, excipient.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "MedicinalProductIngredient.role",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductIngredient.allergenicIndicator",
"path" : "MedicinalProductIngredient.allergenicIndicator",
"short" : "If the ingredient is a known or suspected allergen",
"definition" : "If the ingredient is a known or suspected allergen.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicinalProductIngredient.allergenicIndicator",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductIngredient.manufacturer",
"path" : "MedicinalProductIngredient.manufacturer",
"short" : "Manufacturer of this Ingredient",
"definition" : "Manufacturer of this Ingredient.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicinalProductIngredient.manufacturer",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductIngredient.specifiedSubstance",
"path" : "MedicinalProductIngredient.specifiedSubstance",
"short" : "A specified substance that comprises this ingredient",
"definition" : "A specified substance that comprises this ingredient.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicinalProductIngredient.specifiedSubstance",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductIngredient.specifiedSubstance.id",
"path" : "MedicinalProductIngredient.specifiedSubstance.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MedicinalProductIngredient.specifiedSubstance.extension",
"path" : "MedicinalProductIngredient.specifiedSubstance.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MedicinalProductIngredient.specifiedSubstance.modifierExtension",
"path" : "MedicinalProductIngredient.specifiedSubstance.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MedicinalProductIngredient.specifiedSubstance.code",
"path" : "MedicinalProductIngredient.specifiedSubstance.code",
"short" : "The specified substance",
"definition" : "The specified substance.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "MedicinalProductIngredient.specifiedSubstance.code",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductIngredient.specifiedSubstance.group",
"path" : "MedicinalProductIngredient.specifiedSubstance.group",
"short" : "The group of specified substance, e.g. group 1 to 4",
"definition" : "The group of specified substance, e.g. group 1 to 4.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "MedicinalProductIngredient.specifiedSubstance.group",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductIngredient.specifiedSubstance.confidentiality",
"path" : "MedicinalProductIngredient.specifiedSubstance.confidentiality",
"short" : "Confidentiality level of the specified substance as the ingredient",
"definition" : "Confidentiality level of the specified substance as the ingredient.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicinalProductIngredient.specifiedSubstance.confidentiality",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductIngredient.specifiedSubstance.strength",
"path" : "MedicinalProductIngredient.specifiedSubstance.strength",
"short" : "Quantity of the substance or specified substance present in the manufactured item or pharmaceutical product",
"definition" : "Quantity of the substance or specified substance present in the manufactured item or pharmaceutical product.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicinalProductIngredient.specifiedSubstance.strength",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductIngredient.specifiedSubstance.strength.id",
"path" : "MedicinalProductIngredient.specifiedSubstance.strength.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MedicinalProductIngredient.specifiedSubstance.strength.extension",
"path" : "MedicinalProductIngredient.specifiedSubstance.strength.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MedicinalProductIngredient.specifiedSubstance.strength.modifierExtension",
"path" : "MedicinalProductIngredient.specifiedSubstance.strength.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MedicinalProductIngredient.specifiedSubstance.strength.presentation",
"path" : "MedicinalProductIngredient.specifiedSubstance.strength.presentation",
"short" : "The quantity of substance in the unit of presentation, or in the volume (or mass) of the single pharmaceutical product or manufactured item",
"definition" : "The quantity of substance in the unit of presentation, or in the volume (or mass) of the single pharmaceutical product or manufactured item.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "MedicinalProductIngredient.specifiedSubstance.strength.presentation",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "Ratio"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductIngredient.specifiedSubstance.strength.presentationLowLimit",
"path" : "MedicinalProductIngredient.specifiedSubstance.strength.presentationLowLimit",
"short" : "A lower limit for the quantity of substance in the unit of presentation. For use when there is a range of strengths, this is the lower limit, with the presentation attribute becoming the upper limit",
"definition" : "A lower limit for the quantity of substance in the unit of presentation. For use when there is a range of strengths, this is the lower limit, with the presentation attribute becoming the upper limit.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicinalProductIngredient.specifiedSubstance.strength.presentationLowLimit",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Ratio"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "If this is present it implies that the whole strength is expressed as a range, due to uncertainty or variation",
"isSummary" : true
},
{
"id" : "MedicinalProductIngredient.specifiedSubstance.strength.concentration",
"path" : "MedicinalProductIngredient.specifiedSubstance.strength.concentration",
"short" : "The strength per unitary volume (or mass)",
"definition" : "The strength per unitary volume (or mass).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicinalProductIngredient.specifiedSubstance.strength.concentration",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Ratio"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductIngredient.specifiedSubstance.strength.concentrationLowLimit",
"path" : "MedicinalProductIngredient.specifiedSubstance.strength.concentrationLowLimit",
"short" : "A lower limit for the strength per unitary volume (or mass), for when there is a range. The concentration attribute then becomes the upper limit",
"definition" : "A lower limit for the strength per unitary volume (or mass), for when there is a range. The concentration attribute then becomes the upper limit.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicinalProductIngredient.specifiedSubstance.strength.concentrationLowLimit",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Ratio"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "If this is present it implies that the whole strength is expressed as a range, due to uncertainty or variation",
"isSummary" : true
},
{
"id" : "MedicinalProductIngredient.specifiedSubstance.strength.measurementPoint",
"path" : "MedicinalProductIngredient.specifiedSubstance.strength.measurementPoint",
"short" : "For when strength is measured at a particular point or distance",
"definition" : "For when strength is measured at a particular point or distance.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicinalProductIngredient.specifiedSubstance.strength.measurementPoint",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductIngredient.specifiedSubstance.strength.country",
"path" : "MedicinalProductIngredient.specifiedSubstance.strength.country",
"short" : "The country or countries for which the strength range applies",
"definition" : "The country or countries for which the strength range applies.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicinalProductIngredient.specifiedSubstance.strength.country",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductIngredient.specifiedSubstance.strength.referenceStrength",
"path" : "MedicinalProductIngredient.specifiedSubstance.strength.referenceStrength",
"short" : "Strength expressed in terms of a reference substance",
"definition" : "Strength expressed in terms of a reference substance.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicinalProductIngredient.specifiedSubstance.strength.referenceStrength",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductIngredient.specifiedSubstance.strength.referenceStrength.id",
"path" : "MedicinalProductIngredient.specifiedSubstance.strength.referenceStrength.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MedicinalProductIngredient.specifiedSubstance.strength.referenceStrength.extension",
"path" : "MedicinalProductIngredient.specifiedSubstance.strength.referenceStrength.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MedicinalProductIngredient.specifiedSubstance.strength.referenceStrength.modifierExtension",
"path" : "MedicinalProductIngredient.specifiedSubstance.strength.referenceStrength.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MedicinalProductIngredient.specifiedSubstance.strength.referenceStrength.substance",
"path" : "MedicinalProductIngredient.specifiedSubstance.strength.referenceStrength.substance",
"short" : "Relevant reference substance",
"definition" : "Relevant reference substance.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicinalProductIngredient.specifiedSubstance.strength.referenceStrength.substance",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductIngredient.specifiedSubstance.strength.referenceStrength.strength",
"path" : "MedicinalProductIngredient.specifiedSubstance.strength.referenceStrength.strength",
"short" : "Strength expressed in terms of a reference substance",
"definition" : "Strength expressed in terms of a reference substance.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "MedicinalProductIngredient.specifiedSubstance.strength.referenceStrength.strength",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "Ratio"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductIngredient.specifiedSubstance.strength.referenceStrength.strengthLowLimit",
"path" : "MedicinalProductIngredient.specifiedSubstance.strength.referenceStrength.strengthLowLimit",
"short" : "Strength expressed in terms of a reference substance",
"definition" : "Strength expressed in terms of a reference substance.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicinalProductIngredient.specifiedSubstance.strength.referenceStrength.strengthLowLimit",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Ratio"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductIngredient.specifiedSubstance.strength.referenceStrength.measurementPoint",
"path" : "MedicinalProductIngredient.specifiedSubstance.strength.referenceStrength.measurementPoint",
"short" : "For when strength is measured at a particular point or distance",
"definition" : "For when strength is measured at a particular point or distance.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicinalProductIngredient.specifiedSubstance.strength.referenceStrength.measurementPoint",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductIngredient.specifiedSubstance.strength.referenceStrength.country",
"path" : "MedicinalProductIngredient.specifiedSubstance.strength.referenceStrength.country",
"short" : "The country or countries for which the strength range applies",
"definition" : "The country or countries for which the strength range applies.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicinalProductIngredient.specifiedSubstance.strength.referenceStrength.country",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductIngredient.substance",
"path" : "MedicinalProductIngredient.substance",
"short" : "The ingredient substance",
"definition" : "The ingredient substance.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicinalProductIngredient.substance",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductIngredient.substance.id",
"path" : "MedicinalProductIngredient.substance.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MedicinalProductIngredient.substance.extension",
"path" : "MedicinalProductIngredient.substance.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MedicinalProductIngredient.substance.modifierExtension",
"path" : "MedicinalProductIngredient.substance.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MedicinalProductIngredient.substance.code",
"path" : "MedicinalProductIngredient.substance.code",
"short" : "The ingredient substance",
"definition" : "The ingredient substance.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "MedicinalProductIngredient.substance.code",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductIngredient.substance.strength",
"path" : "MedicinalProductIngredient.substance.strength",
"short" : "Quantity of the substance or specified substance present in the manufactured item or pharmaceutical product",
"definition" : "Quantity of the substance or specified substance present in the manufactured item or pharmaceutical product.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicinalProductIngredient.substance.strength",
"min" : 0,
"max" : "*"
},
"contentReference" : "#MedicinalProductIngredient.specifiedSubstance.strength",
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
}]
},
"differential" : {
"element" : [{
"id" : "MedicinalProductIngredient",
"path" : "MedicinalProductIngredient",
"short" : "An ingredient of a manufactured item or pharmaceutical product",
"definition" : "An ingredient of a manufactured item or pharmaceutical product.",
"min" : 0,
"max" : "*"
},
{
"id" : "MedicinalProductIngredient.identifier",
"path" : "MedicinalProductIngredient.identifier",
"short" : "Identifier for the ingredient",
"definition" : "The identifier(s) of this Ingredient that are assigned by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Identifier"
}],
"isSummary" : true
},
{
"id" : "MedicinalProductIngredient.role",
"path" : "MedicinalProductIngredient.role",
"short" : "Ingredient role e.g. Active ingredient, excipient",
"definition" : "Ingredient role e.g. Active ingredient, excipient.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "MedicinalProductIngredient.allergenicIndicator",
"path" : "MedicinalProductIngredient.allergenicIndicator",
"short" : "If the ingredient is a known or suspected allergen",
"definition" : "If the ingredient is a known or suspected allergen.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "boolean"
}],
"isSummary" : true
},
{
"id" : "MedicinalProductIngredient.manufacturer",
"path" : "MedicinalProductIngredient.manufacturer",
"short" : "Manufacturer of this Ingredient",
"definition" : "Manufacturer of this Ingredient.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"isSummary" : true
},
{
"id" : "MedicinalProductIngredient.specifiedSubstance",
"path" : "MedicinalProductIngredient.specifiedSubstance",
"short" : "A specified substance that comprises this ingredient",
"definition" : "A specified substance that comprises this ingredient.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"isSummary" : true
},
{
"id" : "MedicinalProductIngredient.specifiedSubstance.code",
"path" : "MedicinalProductIngredient.specifiedSubstance.code",
"short" : "The specified substance",
"definition" : "The specified substance.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "MedicinalProductIngredient.specifiedSubstance.group",
"path" : "MedicinalProductIngredient.specifiedSubstance.group",
"short" : "The group of specified substance, e.g. group 1 to 4",
"definition" : "The group of specified substance, e.g. group 1 to 4.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "MedicinalProductIngredient.specifiedSubstance.confidentiality",
"path" : "MedicinalProductIngredient.specifiedSubstance.confidentiality",
"short" : "Confidentiality level of the specified substance as the ingredient",
"definition" : "Confidentiality level of the specified substance as the ingredient.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "MedicinalProductIngredient.specifiedSubstance.strength",
"path" : "MedicinalProductIngredient.specifiedSubstance.strength",
"short" : "Quantity of the substance or specified substance present in the manufactured item or pharmaceutical product",
"definition" : "Quantity of the substance or specified substance present in the manufactured item or pharmaceutical product.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"isSummary" : true
},
{
"id" : "MedicinalProductIngredient.specifiedSubstance.strength.presentation",
"path" : "MedicinalProductIngredient.specifiedSubstance.strength.presentation",
"short" : "The quantity of substance in the unit of presentation, or in the volume (or mass) of the single pharmaceutical product or manufactured item",
"definition" : "The quantity of substance in the unit of presentation, or in the volume (or mass) of the single pharmaceutical product or manufactured item.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "Ratio"
}],
"isSummary" : true
},
{
"id" : "MedicinalProductIngredient.specifiedSubstance.strength.presentationLowLimit",
"path" : "MedicinalProductIngredient.specifiedSubstance.strength.presentationLowLimit",
"short" : "A lower limit for the quantity of substance in the unit of presentation. For use when there is a range of strengths, this is the lower limit, with the presentation attribute becoming the upper limit",
"definition" : "A lower limit for the quantity of substance in the unit of presentation. For use when there is a range of strengths, this is the lower limit, with the presentation attribute becoming the upper limit.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Ratio"
}],
"isModifier" : true,
"isModifierReason" : "If this is present it implies that the whole strength is expressed as a range, due to uncertainty or variation",
"isSummary" : true
},
{
"id" : "MedicinalProductIngredient.specifiedSubstance.strength.concentration",
"path" : "MedicinalProductIngredient.specifiedSubstance.strength.concentration",
"short" : "The strength per unitary volume (or mass)",
"definition" : "The strength per unitary volume (or mass).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Ratio"
}],
"isSummary" : true
},
{
"id" : "MedicinalProductIngredient.specifiedSubstance.strength.concentrationLowLimit",
"path" : "MedicinalProductIngredient.specifiedSubstance.strength.concentrationLowLimit",
"short" : "A lower limit for the strength per unitary volume (or mass), for when there is a range. The concentration attribute then becomes the upper limit",
"definition" : "A lower limit for the strength per unitary volume (or mass), for when there is a range. The concentration attribute then becomes the upper limit.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Ratio"
}],
"isModifier" : true,
"isModifierReason" : "If this is present it implies that the whole strength is expressed as a range, due to uncertainty or variation",
"isSummary" : true
},
{
"id" : "MedicinalProductIngredient.specifiedSubstance.strength.measurementPoint",
"path" : "MedicinalProductIngredient.specifiedSubstance.strength.measurementPoint",
"short" : "For when strength is measured at a particular point or distance",
"definition" : "For when strength is measured at a particular point or distance.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "MedicinalProductIngredient.specifiedSubstance.strength.country",
"path" : "MedicinalProductIngredient.specifiedSubstance.strength.country",
"short" : "The country or countries for which the strength range applies",
"definition" : "The country or countries for which the strength range applies.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "MedicinalProductIngredient.specifiedSubstance.strength.referenceStrength",
"path" : "MedicinalProductIngredient.specifiedSubstance.strength.referenceStrength",
"short" : "Strength expressed in terms of a reference substance",
"definition" : "Strength expressed in terms of a reference substance.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"isSummary" : true
},
{
"id" : "MedicinalProductIngredient.specifiedSubstance.strength.referenceStrength.substance",
"path" : "MedicinalProductIngredient.specifiedSubstance.strength.referenceStrength.substance",
"short" : "Relevant reference substance",
"definition" : "Relevant reference substance.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "MedicinalProductIngredient.specifiedSubstance.strength.referenceStrength.strength",
"path" : "MedicinalProductIngredient.specifiedSubstance.strength.referenceStrength.strength",
"short" : "Strength expressed in terms of a reference substance",
"definition" : "Strength expressed in terms of a reference substance.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "Ratio"
}],
"isSummary" : true
},
{
"id" : "MedicinalProductIngredient.specifiedSubstance.strength.referenceStrength.strengthLowLimit",
"path" : "MedicinalProductIngredient.specifiedSubstance.strength.referenceStrength.strengthLowLimit",
"short" : "Strength expressed in terms of a reference substance",
"definition" : "Strength expressed in terms of a reference substance.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Ratio"
}],
"isSummary" : true
},
{
"id" : "MedicinalProductIngredient.specifiedSubstance.strength.referenceStrength.measurementPoint",
"path" : "MedicinalProductIngredient.specifiedSubstance.strength.referenceStrength.measurementPoint",
"short" : "For when strength is measured at a particular point or distance",
"definition" : "For when strength is measured at a particular point or distance.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "MedicinalProductIngredient.specifiedSubstance.strength.referenceStrength.country",
"path" : "MedicinalProductIngredient.specifiedSubstance.strength.referenceStrength.country",
"short" : "The country or countries for which the strength range applies",
"definition" : "The country or countries for which the strength range applies.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "MedicinalProductIngredient.substance",
"path" : "MedicinalProductIngredient.substance",
"short" : "The ingredient substance",
"definition" : "The ingredient substance.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "BackboneElement"
}],
"isSummary" : true
},
{
"id" : "MedicinalProductIngredient.substance.code",
"path" : "MedicinalProductIngredient.substance.code",
"short" : "The ingredient substance",
"definition" : "The ingredient substance.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "MedicinalProductIngredient.substance.strength",
"path" : "MedicinalProductIngredient.substance.strength",
"short" : "Quantity of the substance or specified substance present in the manufactured item or pharmaceutical product",
"definition" : "Quantity of the substance or specified substance present in the manufactured item or pharmaceutical product.",
"min" : 0,
"max" : "*",
"contentReference" : "#MedicinalProductIngredient.specifiedSubstance.strength",
"isSummary" : true
}]
}
}
},
{
"fullUrl" : "http://hl7.org/fhir/StructureDefinition/MedicinalProductInteraction",
"resource" : {
"resourceType" : "StructureDefinition",
"id" : "MedicinalProductInteraction",
"meta" : {
"lastUpdated" : "2019-11-01T09:29:23.356+11:00"
},
"text" : {
"status" : "generated",
"div" : "Name Flags Card. Type Description & Constraints MedicinalProductInteraction ΣTU DomainResource MedicinalProductInteraction
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension subject Σ 0..* Reference(MedicinalProduct | Medication | Substance) The medication for which this is a described interaction
description Σ 0..1 string The interaction described interactant Σ 0..* BackboneElement The specific medication, food or laboratory test that interacts
item[x] Σ 1..1 The specific medication, food or laboratory test that interacts itemReference Reference(MedicinalProduct | Medication | Substance | ObservationDefinition) itemCodeableConcept CodeableConcept type Σ 0..1 CodeableConcept The type of the interaction e.g. drug-drug interaction, drug-food interaction, drug-lab test interaction effect Σ 0..1 CodeableConcept The effect of the interaction, for example "reduced gastric absorption of primary medication" incidence Σ 0..1 CodeableConcept The incidence of the interaction, e.g. theoretical, observed management Σ 0..1 CodeableConcept Actions for managing the interaction
Documentation for this format
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Specialized.Medication Definition"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 0
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "anonymous"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "brr"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/MedicinalProductInteraction",
"version" : "4.0.1",
"name" : "MedicinalProductInteraction",
"status" : "draft",
"date" : "2019-11-01T09:29:23+11:00",
"publisher" : "Health Level Seven International (Biomedical Research and Regulation)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/rcrim/index.cfm"
}]
}],
"description" : "The interactions of the medicinal product with other medicinal products, or other forms of interactions.",
"fhirVersion" : "4.0.1",
"mapping" : [{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
}],
"kind" : "resource",
"abstract" : false,
"type" : "MedicinalProductInteraction",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "MedicinalProductInteraction",
"path" : "MedicinalProductInteraction",
"short" : "MedicinalProductInteraction",
"definition" : "The interactions of the medicinal product with other medicinal products, or other forms of interactions.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicinalProductInteraction",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "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",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.`div`.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
}]
},
{
"id" : "MedicinalProductInteraction.id",
"path" : "MedicinalProductInteraction.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductInteraction.meta",
"path" : "MedicinalProductInteraction.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductInteraction.implicitRules",
"path" : "MedicinalProductInteraction.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "MedicinalProductInteraction.language",
"path" : "MedicinalProductInteraction.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "MedicinalProductInteraction.text",
"path" : "MedicinalProductInteraction.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "MedicinalProductInteraction.contained",
"path" : "MedicinalProductInteraction.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MedicinalProductInteraction.extension",
"path" : "MedicinalProductInteraction.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MedicinalProductInteraction.modifierExtension",
"path" : "MedicinalProductInteraction.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MedicinalProductInteraction.subject",
"path" : "MedicinalProductInteraction.subject",
"short" : "The medication for which this is a described interaction",
"definition" : "The medication for which this is a described interaction.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicinalProductInteraction.subject",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/MedicinalProduct",
"http://hl7.org/fhir/StructureDefinition/Medication",
"http://hl7.org/fhir/StructureDefinition/Substance"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductInteraction.description",
"path" : "MedicinalProductInteraction.description",
"short" : "The interaction described",
"definition" : "The interaction described.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicinalProductInteraction.description",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductInteraction.interactant",
"path" : "MedicinalProductInteraction.interactant",
"short" : "The specific medication, food or laboratory test that interacts",
"definition" : "The specific medication, food or laboratory test that interacts.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicinalProductInteraction.interactant",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductInteraction.interactant.id",
"path" : "MedicinalProductInteraction.interactant.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MedicinalProductInteraction.interactant.extension",
"path" : "MedicinalProductInteraction.interactant.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MedicinalProductInteraction.interactant.modifierExtension",
"path" : "MedicinalProductInteraction.interactant.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MedicinalProductInteraction.interactant.item[x]",
"path" : "MedicinalProductInteraction.interactant.item[x]",
"short" : "The specific medication, food or laboratory test that interacts",
"definition" : "The specific medication, food or laboratory test that interacts.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "MedicinalProductInteraction.interactant.item[x]",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/MedicinalProduct",
"http://hl7.org/fhir/StructureDefinition/Medication",
"http://hl7.org/fhir/StructureDefinition/Substance",
"http://hl7.org/fhir/StructureDefinition/ObservationDefinition"]
},
{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductInteraction.type",
"path" : "MedicinalProductInteraction.type",
"short" : "The type of the interaction e.g. drug-drug interaction, drug-food interaction, drug-lab test interaction",
"definition" : "The type of the interaction e.g. drug-drug interaction, drug-food interaction, drug-lab test interaction.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicinalProductInteraction.type",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductInteraction.effect",
"path" : "MedicinalProductInteraction.effect",
"short" : "The effect of the interaction, for example \"reduced gastric absorption of primary medication\"",
"definition" : "The effect of the interaction, for example \"reduced gastric absorption of primary medication\".",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicinalProductInteraction.effect",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductInteraction.incidence",
"path" : "MedicinalProductInteraction.incidence",
"short" : "The incidence of the interaction, e.g. theoretical, observed",
"definition" : "The incidence of the interaction, e.g. theoretical, observed.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicinalProductInteraction.incidence",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductInteraction.management",
"path" : "MedicinalProductInteraction.management",
"short" : "Actions for managing the interaction",
"definition" : "Actions for managing the interaction.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicinalProductInteraction.management",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
}]
},
"differential" : {
"element" : [{
"id" : "MedicinalProductInteraction",
"path" : "MedicinalProductInteraction",
"short" : "MedicinalProductInteraction",
"definition" : "The interactions of the medicinal product with other medicinal products, or other forms of interactions.",
"min" : 0,
"max" : "*"
},
{
"id" : "MedicinalProductInteraction.subject",
"path" : "MedicinalProductInteraction.subject",
"short" : "The medication for which this is a described interaction",
"definition" : "The medication for which this is a described interaction.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/MedicinalProduct",
"http://hl7.org/fhir/StructureDefinition/Medication",
"http://hl7.org/fhir/StructureDefinition/Substance"]
}],
"isSummary" : true
},
{
"id" : "MedicinalProductInteraction.description",
"path" : "MedicinalProductInteraction.description",
"short" : "The interaction described",
"definition" : "The interaction described.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "MedicinalProductInteraction.interactant",
"path" : "MedicinalProductInteraction.interactant",
"short" : "The specific medication, food or laboratory test that interacts",
"definition" : "The specific medication, food or laboratory test that interacts.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"isSummary" : true
},
{
"id" : "MedicinalProductInteraction.interactant.item[x]",
"path" : "MedicinalProductInteraction.interactant.item[x]",
"short" : "The specific medication, food or laboratory test that interacts",
"definition" : "The specific medication, food or laboratory test that interacts.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/MedicinalProduct",
"http://hl7.org/fhir/StructureDefinition/Medication",
"http://hl7.org/fhir/StructureDefinition/Substance",
"http://hl7.org/fhir/StructureDefinition/ObservationDefinition"]
},
{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "MedicinalProductInteraction.type",
"path" : "MedicinalProductInteraction.type",
"short" : "The type of the interaction e.g. drug-drug interaction, drug-food interaction, drug-lab test interaction",
"definition" : "The type of the interaction e.g. drug-drug interaction, drug-food interaction, drug-lab test interaction.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "MedicinalProductInteraction.effect",
"path" : "MedicinalProductInteraction.effect",
"short" : "The effect of the interaction, for example \"reduced gastric absorption of primary medication\"",
"definition" : "The effect of the interaction, for example \"reduced gastric absorption of primary medication\".",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "MedicinalProductInteraction.incidence",
"path" : "MedicinalProductInteraction.incidence",
"short" : "The incidence of the interaction, e.g. theoretical, observed",
"definition" : "The incidence of the interaction, e.g. theoretical, observed.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "MedicinalProductInteraction.management",
"path" : "MedicinalProductInteraction.management",
"short" : "Actions for managing the interaction",
"definition" : "Actions for managing the interaction.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
}]
}
}
},
{
"fullUrl" : "http://hl7.org/fhir/StructureDefinition/MedicinalProductManufactured",
"resource" : {
"resourceType" : "StructureDefinition",
"id" : "MedicinalProductManufactured",
"meta" : {
"lastUpdated" : "2019-11-01T09:29:23.356+11:00"
},
"text" : {
"status" : "generated",
"div" : "Name Flags Card. Type Description & Constraints MedicinalProductManufactured ΣTU DomainResource The manufactured item as contained in the packaged medicinal product
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension manufacturedDoseForm Σ 1..1 CodeableConcept Dose form as manufactured and before any transformation into the pharmaceutical product unitOfPresentation Σ 0..1 CodeableConcept The “real world” units in which the quantity of the manufactured item is described quantity Σ 1..1 Quantity The quantity or "count number" of the manufactured item manufacturer Σ 0..* Reference(Organization) Manufacturer of the item (Note that this should be named "manufacturer" but it currently causes technical issues)
ingredient Σ 0..* Reference(MedicinalProductIngredient) Ingredient
physicalCharacteristics Σ 0..1 ProdCharacteristic Dimensions, color etc. otherCharacteristics Σ 0..* CodeableConcept Other codeable characteristics
Documentation for this format
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Specialized.Medication Definition"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 0
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "anonymous"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "brr"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/MedicinalProductManufactured",
"version" : "4.0.1",
"name" : "MedicinalProductManufactured",
"status" : "draft",
"date" : "2019-11-01T09:29:23+11:00",
"publisher" : "Health Level Seven International (Biomedical Research and Regulation)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/rcrim/index.cfm"
}]
}],
"description" : "The manufactured item as contained in the packaged medicinal product.",
"fhirVersion" : "4.0.1",
"mapping" : [{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
}],
"kind" : "resource",
"abstract" : false,
"type" : "MedicinalProductManufactured",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "MedicinalProductManufactured",
"path" : "MedicinalProductManufactured",
"short" : "The manufactured item as contained in the packaged medicinal product",
"definition" : "The manufactured item as contained in the packaged medicinal product.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicinalProductManufactured",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "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",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.`div`.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
}]
},
{
"id" : "MedicinalProductManufactured.id",
"path" : "MedicinalProductManufactured.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductManufactured.meta",
"path" : "MedicinalProductManufactured.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductManufactured.implicitRules",
"path" : "MedicinalProductManufactured.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "MedicinalProductManufactured.language",
"path" : "MedicinalProductManufactured.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "MedicinalProductManufactured.text",
"path" : "MedicinalProductManufactured.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "MedicinalProductManufactured.contained",
"path" : "MedicinalProductManufactured.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MedicinalProductManufactured.extension",
"path" : "MedicinalProductManufactured.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MedicinalProductManufactured.modifierExtension",
"path" : "MedicinalProductManufactured.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MedicinalProductManufactured.manufacturedDoseForm",
"path" : "MedicinalProductManufactured.manufacturedDoseForm",
"short" : "Dose form as manufactured and before any transformation into the pharmaceutical product",
"definition" : "Dose form as manufactured and before any transformation into the pharmaceutical product.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "MedicinalProductManufactured.manufacturedDoseForm",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductManufactured.unitOfPresentation",
"path" : "MedicinalProductManufactured.unitOfPresentation",
"short" : "The “real world” units in which the quantity of the manufactured item is described",
"definition" : "The “real world” units in which the quantity of the manufactured item is described.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicinalProductManufactured.unitOfPresentation",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductManufactured.quantity",
"path" : "MedicinalProductManufactured.quantity",
"short" : "The quantity or \"count number\" of the manufactured item",
"definition" : "The quantity or \"count number\" of the manufactured item.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "MedicinalProductManufactured.quantity",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "Quantity"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductManufactured.manufacturer",
"path" : "MedicinalProductManufactured.manufacturer",
"short" : "Manufacturer of the item (Note that this should be named \"manufacturer\" but it currently causes technical issues)",
"definition" : "Manufacturer of the item (Note that this should be named \"manufacturer\" but it currently causes technical issues).",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicinalProductManufactured.manufacturer",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductManufactured.ingredient",
"path" : "MedicinalProductManufactured.ingredient",
"short" : "Ingredient",
"definition" : "Ingredient.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicinalProductManufactured.ingredient",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/MedicinalProductIngredient"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductManufactured.physicalCharacteristics",
"path" : "MedicinalProductManufactured.physicalCharacteristics",
"short" : "Dimensions, color etc.",
"definition" : "Dimensions, color etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicinalProductManufactured.physicalCharacteristics",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "ProdCharacteristic"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductManufactured.otherCharacteristics",
"path" : "MedicinalProductManufactured.otherCharacteristics",
"short" : "Other codeable characteristics",
"definition" : "Other codeable characteristics.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicinalProductManufactured.otherCharacteristics",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
}]
},
"differential" : {
"element" : [{
"id" : "MedicinalProductManufactured",
"path" : "MedicinalProductManufactured",
"short" : "The manufactured item as contained in the packaged medicinal product",
"definition" : "The manufactured item as contained in the packaged medicinal product.",
"min" : 0,
"max" : "*"
},
{
"id" : "MedicinalProductManufactured.manufacturedDoseForm",
"path" : "MedicinalProductManufactured.manufacturedDoseForm",
"short" : "Dose form as manufactured and before any transformation into the pharmaceutical product",
"definition" : "Dose form as manufactured and before any transformation into the pharmaceutical product.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "MedicinalProductManufactured.unitOfPresentation",
"path" : "MedicinalProductManufactured.unitOfPresentation",
"short" : "The “real world” units in which the quantity of the manufactured item is described",
"definition" : "The “real world” units in which the quantity of the manufactured item is described.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "MedicinalProductManufactured.quantity",
"path" : "MedicinalProductManufactured.quantity",
"short" : "The quantity or \"count number\" of the manufactured item",
"definition" : "The quantity or \"count number\" of the manufactured item.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "Quantity"
}],
"isSummary" : true
},
{
"id" : "MedicinalProductManufactured.manufacturer",
"path" : "MedicinalProductManufactured.manufacturer",
"short" : "Manufacturer of the item (Note that this should be named \"manufacturer\" but it currently causes technical issues)",
"definition" : "Manufacturer of the item (Note that this should be named \"manufacturer\" but it currently causes technical issues).",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"isSummary" : true
},
{
"id" : "MedicinalProductManufactured.ingredient",
"path" : "MedicinalProductManufactured.ingredient",
"short" : "Ingredient",
"definition" : "Ingredient.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/MedicinalProductIngredient"]
}],
"isSummary" : true
},
{
"id" : "MedicinalProductManufactured.physicalCharacteristics",
"path" : "MedicinalProductManufactured.physicalCharacteristics",
"short" : "Dimensions, color etc.",
"definition" : "Dimensions, color etc.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "ProdCharacteristic"
}],
"isSummary" : true
},
{
"id" : "MedicinalProductManufactured.otherCharacteristics",
"path" : "MedicinalProductManufactured.otherCharacteristics",
"short" : "Other codeable characteristics",
"definition" : "Other codeable characteristics.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
}]
}
}
},
{
"fullUrl" : "http://hl7.org/fhir/StructureDefinition/MedicinalProductPackaged",
"resource" : {
"resourceType" : "StructureDefinition",
"id" : "MedicinalProductPackaged",
"meta" : {
"lastUpdated" : "2019-11-01T09:29:23.356+11:00"
},
"text" : {
"status" : "generated",
"div" : "Name Flags Card. Type Description & Constraints MedicinalProductPackaged ΣTU DomainResource A medicinal product in a container or package
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension identifier Σ 0..* Identifier Unique identifier
subject Σ 0..* Reference(MedicinalProduct) The product with this is a pack for
description Σ 0..1 string Textual description legalStatusOfSupply Σ 0..1 CodeableConcept The legal status of supply of the medicinal product as classified by the regulator marketingStatus Σ 0..* MarketingStatus Marketing information
marketingAuthorization Σ 0..1 Reference(MedicinalProductAuthorization) Manufacturer of this Package Item manufacturer Σ 0..* Reference(Organization) Manufacturer of this Package Item
batchIdentifier Σ 0..* BackboneElement Batch numbering
outerPackaging Σ 1..1 Identifier A number appearing on the outer packaging of a specific batch immediatePackaging Σ 0..1 Identifier A number appearing on the immediate packaging (and not the outer packaging) packageItem Σ 1..* BackboneElement A packaging item, as a contained for medicine, possibly with other packaging items within
identifier Σ 0..* Identifier Including possibly Data Carrier Identifier
type Σ 1..1 CodeableConcept The physical type of the container of the medicine quantity Σ 1..1 Quantity The quantity of this package in the medicinal product, at the current level of packaging. The outermost is always 1 material Σ 0..* CodeableConcept Material type of the package item
alternateMaterial Σ 0..* CodeableConcept A possible alternate material for the packaging
device Σ 0..* Reference(DeviceDefinition) A device accompanying a medicinal product
manufacturedItem Σ 0..* Reference(MedicinalProductManufactured) The manufactured item as contained in the packaged medicinal product
packageItem Σ 0..* see packageItem Allows containers within containers
physicalCharacteristics Σ 0..1 ProdCharacteristic Dimensions, color etc. otherCharacteristics Σ 0..* CodeableConcept Other codeable characteristics
shelfLifeStorage Σ 0..* ProductShelfLife Shelf Life and storage information
manufacturer Σ 0..* Reference(Organization) Manufacturer of this Package Item
Documentation for this format
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Specialized.Medication Definition"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 0
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "anonymous"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "brr"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/MedicinalProductPackaged",
"version" : "4.0.1",
"name" : "MedicinalProductPackaged",
"status" : "draft",
"date" : "2019-11-01T09:29:23+11:00",
"publisher" : "Health Level Seven International (Biomedical Research and Regulation)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/rcrim/index.cfm"
}]
}],
"description" : "A medicinal product in a container or package.",
"fhirVersion" : "4.0.1",
"mapping" : [{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
}],
"kind" : "resource",
"abstract" : false,
"type" : "MedicinalProductPackaged",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "MedicinalProductPackaged",
"path" : "MedicinalProductPackaged",
"short" : "A medicinal product in a container or package",
"definition" : "A medicinal product in a container or package.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicinalProductPackaged",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "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",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.`div`.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
}]
},
{
"id" : "MedicinalProductPackaged.id",
"path" : "MedicinalProductPackaged.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductPackaged.meta",
"path" : "MedicinalProductPackaged.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductPackaged.implicitRules",
"path" : "MedicinalProductPackaged.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "MedicinalProductPackaged.language",
"path" : "MedicinalProductPackaged.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "MedicinalProductPackaged.text",
"path" : "MedicinalProductPackaged.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "MedicinalProductPackaged.contained",
"path" : "MedicinalProductPackaged.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MedicinalProductPackaged.extension",
"path" : "MedicinalProductPackaged.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MedicinalProductPackaged.modifierExtension",
"path" : "MedicinalProductPackaged.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MedicinalProductPackaged.identifier",
"path" : "MedicinalProductPackaged.identifier",
"short" : "Unique identifier",
"definition" : "Unique identifier.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicinalProductPackaged.identifier",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Identifier"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductPackaged.subject",
"path" : "MedicinalProductPackaged.subject",
"short" : "The product with this is a pack for",
"definition" : "The product with this is a pack for.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicinalProductPackaged.subject",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/MedicinalProduct"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductPackaged.description",
"path" : "MedicinalProductPackaged.description",
"short" : "Textual description",
"definition" : "Textual description.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicinalProductPackaged.description",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductPackaged.legalStatusOfSupply",
"path" : "MedicinalProductPackaged.legalStatusOfSupply",
"short" : "The legal status of supply of the medicinal product as classified by the regulator",
"definition" : "The legal status of supply of the medicinal product as classified by the regulator.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicinalProductPackaged.legalStatusOfSupply",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductPackaged.marketingStatus",
"path" : "MedicinalProductPackaged.marketingStatus",
"short" : "Marketing information",
"definition" : "Marketing information.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicinalProductPackaged.marketingStatus",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "MarketingStatus"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductPackaged.marketingAuthorization",
"path" : "MedicinalProductPackaged.marketingAuthorization",
"short" : "Manufacturer of this Package Item",
"definition" : "Manufacturer of this Package Item.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicinalProductPackaged.marketingAuthorization",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/MedicinalProductAuthorization"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductPackaged.manufacturer",
"path" : "MedicinalProductPackaged.manufacturer",
"short" : "Manufacturer of this Package Item",
"definition" : "Manufacturer of this Package Item.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicinalProductPackaged.manufacturer",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductPackaged.batchIdentifier",
"path" : "MedicinalProductPackaged.batchIdentifier",
"short" : "Batch numbering",
"definition" : "Batch numbering.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicinalProductPackaged.batchIdentifier",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductPackaged.batchIdentifier.id",
"path" : "MedicinalProductPackaged.batchIdentifier.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MedicinalProductPackaged.batchIdentifier.extension",
"path" : "MedicinalProductPackaged.batchIdentifier.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MedicinalProductPackaged.batchIdentifier.modifierExtension",
"path" : "MedicinalProductPackaged.batchIdentifier.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MedicinalProductPackaged.batchIdentifier.outerPackaging",
"path" : "MedicinalProductPackaged.batchIdentifier.outerPackaging",
"short" : "A number appearing on the outer packaging of a specific batch",
"definition" : "A number appearing on the outer packaging of a specific batch.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "MedicinalProductPackaged.batchIdentifier.outerPackaging",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "Identifier"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductPackaged.batchIdentifier.immediatePackaging",
"path" : "MedicinalProductPackaged.batchIdentifier.immediatePackaging",
"short" : "A number appearing on the immediate packaging (and not the outer packaging)",
"definition" : "A number appearing on the immediate packaging (and not the outer packaging).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicinalProductPackaged.batchIdentifier.immediatePackaging",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Identifier"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductPackaged.packageItem",
"path" : "MedicinalProductPackaged.packageItem",
"short" : "A packaging item, as a contained for medicine, possibly with other packaging items within",
"definition" : "A packaging item, as a contained for medicine, possibly with other packaging items within.",
"min" : 1,
"max" : "*",
"base" : {
"path" : "MedicinalProductPackaged.packageItem",
"min" : 1,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductPackaged.packageItem.id",
"path" : "MedicinalProductPackaged.packageItem.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MedicinalProductPackaged.packageItem.extension",
"path" : "MedicinalProductPackaged.packageItem.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MedicinalProductPackaged.packageItem.modifierExtension",
"path" : "MedicinalProductPackaged.packageItem.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MedicinalProductPackaged.packageItem.identifier",
"path" : "MedicinalProductPackaged.packageItem.identifier",
"short" : "Including possibly Data Carrier Identifier",
"definition" : "Including possibly Data Carrier Identifier.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicinalProductPackaged.packageItem.identifier",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Identifier"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductPackaged.packageItem.type",
"path" : "MedicinalProductPackaged.packageItem.type",
"short" : "The physical type of the container of the medicine",
"definition" : "The physical type of the container of the medicine.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "MedicinalProductPackaged.packageItem.type",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductPackaged.packageItem.quantity",
"path" : "MedicinalProductPackaged.packageItem.quantity",
"short" : "The quantity of this package in the medicinal product, at the current level of packaging. The outermost is always 1",
"definition" : "The quantity of this package in the medicinal product, at the current level of packaging. The outermost is always 1.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "MedicinalProductPackaged.packageItem.quantity",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "Quantity"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductPackaged.packageItem.material",
"path" : "MedicinalProductPackaged.packageItem.material",
"short" : "Material type of the package item",
"definition" : "Material type of the package item.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicinalProductPackaged.packageItem.material",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductPackaged.packageItem.alternateMaterial",
"path" : "MedicinalProductPackaged.packageItem.alternateMaterial",
"short" : "A possible alternate material for the packaging",
"definition" : "A possible alternate material for the packaging.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicinalProductPackaged.packageItem.alternateMaterial",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductPackaged.packageItem.device",
"path" : "MedicinalProductPackaged.packageItem.device",
"short" : "A device accompanying a medicinal product",
"definition" : "A device accompanying a medicinal product.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicinalProductPackaged.packageItem.device",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/DeviceDefinition"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductPackaged.packageItem.manufacturedItem",
"path" : "MedicinalProductPackaged.packageItem.manufacturedItem",
"short" : "The manufactured item as contained in the packaged medicinal product",
"definition" : "The manufactured item as contained in the packaged medicinal product.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicinalProductPackaged.packageItem.manufacturedItem",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/MedicinalProductManufactured"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductPackaged.packageItem.packageItem",
"path" : "MedicinalProductPackaged.packageItem.packageItem",
"short" : "Allows containers within containers",
"definition" : "Allows containers within containers.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicinalProductPackaged.packageItem.packageItem",
"min" : 0,
"max" : "*"
},
"contentReference" : "#MedicinalProductPackaged.packageItem",
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductPackaged.packageItem.physicalCharacteristics",
"path" : "MedicinalProductPackaged.packageItem.physicalCharacteristics",
"short" : "Dimensions, color etc.",
"definition" : "Dimensions, color etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicinalProductPackaged.packageItem.physicalCharacteristics",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "ProdCharacteristic"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductPackaged.packageItem.otherCharacteristics",
"path" : "MedicinalProductPackaged.packageItem.otherCharacteristics",
"short" : "Other codeable characteristics",
"definition" : "Other codeable characteristics.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicinalProductPackaged.packageItem.otherCharacteristics",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductPackaged.packageItem.shelfLifeStorage",
"path" : "MedicinalProductPackaged.packageItem.shelfLifeStorage",
"short" : "Shelf Life and storage information",
"definition" : "Shelf Life and storage information.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicinalProductPackaged.packageItem.shelfLifeStorage",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "ProductShelfLife"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductPackaged.packageItem.manufacturer",
"path" : "MedicinalProductPackaged.packageItem.manufacturer",
"short" : "Manufacturer of this Package Item",
"definition" : "Manufacturer of this Package Item.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicinalProductPackaged.packageItem.manufacturer",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
}]
},
"differential" : {
"element" : [{
"id" : "MedicinalProductPackaged",
"path" : "MedicinalProductPackaged",
"short" : "A medicinal product in a container or package",
"definition" : "A medicinal product in a container or package.",
"min" : 0,
"max" : "*"
},
{
"id" : "MedicinalProductPackaged.identifier",
"path" : "MedicinalProductPackaged.identifier",
"short" : "Unique identifier",
"definition" : "Unique identifier.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Identifier"
}],
"isSummary" : true
},
{
"id" : "MedicinalProductPackaged.subject",
"path" : "MedicinalProductPackaged.subject",
"short" : "The product with this is a pack for",
"definition" : "The product with this is a pack for.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/MedicinalProduct"]
}],
"isSummary" : true
},
{
"id" : "MedicinalProductPackaged.description",
"path" : "MedicinalProductPackaged.description",
"short" : "Textual description",
"definition" : "Textual description.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "MedicinalProductPackaged.legalStatusOfSupply",
"path" : "MedicinalProductPackaged.legalStatusOfSupply",
"short" : "The legal status of supply of the medicinal product as classified by the regulator",
"definition" : "The legal status of supply of the medicinal product as classified by the regulator.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "MedicinalProductPackaged.marketingStatus",
"path" : "MedicinalProductPackaged.marketingStatus",
"short" : "Marketing information",
"definition" : "Marketing information.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "MarketingStatus"
}],
"isSummary" : true
},
{
"id" : "MedicinalProductPackaged.marketingAuthorization",
"path" : "MedicinalProductPackaged.marketingAuthorization",
"short" : "Manufacturer of this Package Item",
"definition" : "Manufacturer of this Package Item.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/MedicinalProductAuthorization"]
}],
"isSummary" : true
},
{
"id" : "MedicinalProductPackaged.manufacturer",
"path" : "MedicinalProductPackaged.manufacturer",
"short" : "Manufacturer of this Package Item",
"definition" : "Manufacturer of this Package Item.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"isSummary" : true
},
{
"id" : "MedicinalProductPackaged.batchIdentifier",
"path" : "MedicinalProductPackaged.batchIdentifier",
"short" : "Batch numbering",
"definition" : "Batch numbering.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"isSummary" : true
},
{
"id" : "MedicinalProductPackaged.batchIdentifier.outerPackaging",
"path" : "MedicinalProductPackaged.batchIdentifier.outerPackaging",
"short" : "A number appearing on the outer packaging of a specific batch",
"definition" : "A number appearing on the outer packaging of a specific batch.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "Identifier"
}],
"isSummary" : true
},
{
"id" : "MedicinalProductPackaged.batchIdentifier.immediatePackaging",
"path" : "MedicinalProductPackaged.batchIdentifier.immediatePackaging",
"short" : "A number appearing on the immediate packaging (and not the outer packaging)",
"definition" : "A number appearing on the immediate packaging (and not the outer packaging).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Identifier"
}],
"isSummary" : true
},
{
"id" : "MedicinalProductPackaged.packageItem",
"path" : "MedicinalProductPackaged.packageItem",
"short" : "A packaging item, as a contained for medicine, possibly with other packaging items within",
"definition" : "A packaging item, as a contained for medicine, possibly with other packaging items within.",
"min" : 1,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"isSummary" : true
},
{
"id" : "MedicinalProductPackaged.packageItem.identifier",
"path" : "MedicinalProductPackaged.packageItem.identifier",
"short" : "Including possibly Data Carrier Identifier",
"definition" : "Including possibly Data Carrier Identifier.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Identifier"
}],
"isSummary" : true
},
{
"id" : "MedicinalProductPackaged.packageItem.type",
"path" : "MedicinalProductPackaged.packageItem.type",
"short" : "The physical type of the container of the medicine",
"definition" : "The physical type of the container of the medicine.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "MedicinalProductPackaged.packageItem.quantity",
"path" : "MedicinalProductPackaged.packageItem.quantity",
"short" : "The quantity of this package in the medicinal product, at the current level of packaging. The outermost is always 1",
"definition" : "The quantity of this package in the medicinal product, at the current level of packaging. The outermost is always 1.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "Quantity"
}],
"isSummary" : true
},
{
"id" : "MedicinalProductPackaged.packageItem.material",
"path" : "MedicinalProductPackaged.packageItem.material",
"short" : "Material type of the package item",
"definition" : "Material type of the package item.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "MedicinalProductPackaged.packageItem.alternateMaterial",
"path" : "MedicinalProductPackaged.packageItem.alternateMaterial",
"short" : "A possible alternate material for the packaging",
"definition" : "A possible alternate material for the packaging.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "MedicinalProductPackaged.packageItem.device",
"path" : "MedicinalProductPackaged.packageItem.device",
"short" : "A device accompanying a medicinal product",
"definition" : "A device accompanying a medicinal product.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/DeviceDefinition"]
}],
"isSummary" : true
},
{
"id" : "MedicinalProductPackaged.packageItem.manufacturedItem",
"path" : "MedicinalProductPackaged.packageItem.manufacturedItem",
"short" : "The manufactured item as contained in the packaged medicinal product",
"definition" : "The manufactured item as contained in the packaged medicinal product.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/MedicinalProductManufactured"]
}],
"isSummary" : true
},
{
"id" : "MedicinalProductPackaged.packageItem.packageItem",
"path" : "MedicinalProductPackaged.packageItem.packageItem",
"short" : "Allows containers within containers",
"definition" : "Allows containers within containers.",
"min" : 0,
"max" : "*",
"contentReference" : "#MedicinalProductPackaged.packageItem",
"isSummary" : true
},
{
"id" : "MedicinalProductPackaged.packageItem.physicalCharacteristics",
"path" : "MedicinalProductPackaged.packageItem.physicalCharacteristics",
"short" : "Dimensions, color etc.",
"definition" : "Dimensions, color etc.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "ProdCharacteristic"
}],
"isSummary" : true
},
{
"id" : "MedicinalProductPackaged.packageItem.otherCharacteristics",
"path" : "MedicinalProductPackaged.packageItem.otherCharacteristics",
"short" : "Other codeable characteristics",
"definition" : "Other codeable characteristics.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "MedicinalProductPackaged.packageItem.shelfLifeStorage",
"path" : "MedicinalProductPackaged.packageItem.shelfLifeStorage",
"short" : "Shelf Life and storage information",
"definition" : "Shelf Life and storage information.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "ProductShelfLife"
}],
"isSummary" : true
},
{
"id" : "MedicinalProductPackaged.packageItem.manufacturer",
"path" : "MedicinalProductPackaged.packageItem.manufacturer",
"short" : "Manufacturer of this Package Item",
"definition" : "Manufacturer of this Package Item.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"isSummary" : true
}]
}
}
},
{
"fullUrl" : "http://hl7.org/fhir/StructureDefinition/MedicinalProductPharmaceutical",
"resource" : {
"resourceType" : "StructureDefinition",
"id" : "MedicinalProductPharmaceutical",
"meta" : {
"lastUpdated" : "2019-11-01T09:29:23.356+11:00"
},
"text" : {
"status" : "generated",
"div" : "Name Flags Card. Type Description & Constraints MedicinalProductPharmaceutical ΣTU DomainResource A pharmaceutical product described in terms of its composition and dose form
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension identifier Σ 0..* Identifier An identifier for the pharmaceutical medicinal product
administrableDoseForm Σ 1..1 CodeableConcept The administrable dose form, after necessary reconstitution unitOfPresentation Σ 0..1 CodeableConcept Todo ingredient Σ 0..* Reference(MedicinalProductIngredient) Ingredient
device Σ 0..* Reference(DeviceDefinition) Accompanying device
characteristics Σ 0..* BackboneElement Characteristics e.g. a products onset of action
code Σ 1..1 CodeableConcept A coded characteristic status Σ 0..1 CodeableConcept The status of characteristic e.g. assigned or pending routeOfAdministration Σ 1..* BackboneElement The path by which the pharmaceutical product is taken into or makes contact with the body
code Σ 1..1 CodeableConcept Coded expression for the route firstDose Σ 0..1 Quantity The first dose (dose quantity) administered in humans can be specified, for a product under investigation, using a numerical value and its unit of measurement maxSingleDose Σ 0..1 Quantity The maximum single dose that can be administered as per the protocol of a clinical trial can be specified using a numerical value and its unit of measurement maxDosePerDay Σ 0..1 Quantity The maximum dose per day (maximum dose quantity to be administered in any one 24-h period) that can be administered as per the protocol referenced in the clinical trial authorisation maxDosePerTreatmentPeriod Σ 0..1 Ratio The maximum dose per treatment period that can be administered as per the protocol referenced in the clinical trial authorisation maxTreatmentPeriod Σ 0..1 Duration The maximum treatment period during which an Investigational Medicinal Product can be administered as per the protocol referenced in the clinical trial authorisation targetSpecies Σ 0..* BackboneElement A species for which this route applies
code Σ 1..1 CodeableConcept Coded expression for the species withdrawalPeriod Σ 0..* BackboneElement A species specific time during which consumption of animal product is not appropriate
tissue Σ 1..1 CodeableConcept Coded expression for the type of tissue for which the withdrawal period applues, e.g. meat, milk value Σ 1..1 Quantity A value for the time supportingInformation Σ 0..1 string Extra information about the withdrawal period
Documentation for this format
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Specialized.Medication Definition"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 0
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "anonymous"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "brr"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/MedicinalProductPharmaceutical",
"version" : "4.0.1",
"name" : "MedicinalProductPharmaceutical",
"status" : "draft",
"date" : "2019-11-01T09:29:23+11:00",
"publisher" : "Health Level Seven International (Biomedical Research and Regulation)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/rcrim/index.cfm"
}]
}],
"description" : "A pharmaceutical product described in terms of its composition and dose form.",
"fhirVersion" : "4.0.1",
"mapping" : [{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
}],
"kind" : "resource",
"abstract" : false,
"type" : "MedicinalProductPharmaceutical",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "MedicinalProductPharmaceutical",
"path" : "MedicinalProductPharmaceutical",
"short" : "A pharmaceutical product described in terms of its composition and dose form",
"definition" : "A pharmaceutical product described in terms of its composition and dose form.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicinalProductPharmaceutical",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "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",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.`div`.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
}]
},
{
"id" : "MedicinalProductPharmaceutical.id",
"path" : "MedicinalProductPharmaceutical.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductPharmaceutical.meta",
"path" : "MedicinalProductPharmaceutical.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductPharmaceutical.implicitRules",
"path" : "MedicinalProductPharmaceutical.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "MedicinalProductPharmaceutical.language",
"path" : "MedicinalProductPharmaceutical.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "MedicinalProductPharmaceutical.text",
"path" : "MedicinalProductPharmaceutical.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "MedicinalProductPharmaceutical.contained",
"path" : "MedicinalProductPharmaceutical.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MedicinalProductPharmaceutical.extension",
"path" : "MedicinalProductPharmaceutical.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MedicinalProductPharmaceutical.modifierExtension",
"path" : "MedicinalProductPharmaceutical.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MedicinalProductPharmaceutical.identifier",
"path" : "MedicinalProductPharmaceutical.identifier",
"short" : "An identifier for the pharmaceutical medicinal product",
"definition" : "An identifier for the pharmaceutical medicinal product.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicinalProductPharmaceutical.identifier",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Identifier"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductPharmaceutical.administrableDoseForm",
"path" : "MedicinalProductPharmaceutical.administrableDoseForm",
"short" : "The administrable dose form, after necessary reconstitution",
"definition" : "The administrable dose form, after necessary reconstitution.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "MedicinalProductPharmaceutical.administrableDoseForm",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductPharmaceutical.unitOfPresentation",
"path" : "MedicinalProductPharmaceutical.unitOfPresentation",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicinalProductPharmaceutical.unitOfPresentation",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductPharmaceutical.ingredient",
"path" : "MedicinalProductPharmaceutical.ingredient",
"short" : "Ingredient",
"definition" : "Ingredient.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicinalProductPharmaceutical.ingredient",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/MedicinalProductIngredient"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductPharmaceutical.device",
"path" : "MedicinalProductPharmaceutical.device",
"short" : "Accompanying device",
"definition" : "Accompanying device.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicinalProductPharmaceutical.device",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/DeviceDefinition"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductPharmaceutical.characteristics",
"path" : "MedicinalProductPharmaceutical.characteristics",
"short" : "Characteristics e.g. a products onset of action",
"definition" : "Characteristics e.g. a products onset of action.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicinalProductPharmaceutical.characteristics",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductPharmaceutical.characteristics.id",
"path" : "MedicinalProductPharmaceutical.characteristics.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MedicinalProductPharmaceutical.characteristics.extension",
"path" : "MedicinalProductPharmaceutical.characteristics.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MedicinalProductPharmaceutical.characteristics.modifierExtension",
"path" : "MedicinalProductPharmaceutical.characteristics.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MedicinalProductPharmaceutical.characteristics.code",
"path" : "MedicinalProductPharmaceutical.characteristics.code",
"short" : "A coded characteristic",
"definition" : "A coded characteristic.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "MedicinalProductPharmaceutical.characteristics.code",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductPharmaceutical.characteristics.status",
"path" : "MedicinalProductPharmaceutical.characteristics.status",
"short" : "The status of characteristic e.g. assigned or pending",
"definition" : "The status of characteristic e.g. assigned or pending.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicinalProductPharmaceutical.characteristics.status",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductPharmaceutical.routeOfAdministration",
"path" : "MedicinalProductPharmaceutical.routeOfAdministration",
"short" : "The path by which the pharmaceutical product is taken into or makes contact with the body",
"definition" : "The path by which the pharmaceutical product is taken into or makes contact with the body.",
"min" : 1,
"max" : "*",
"base" : {
"path" : "MedicinalProductPharmaceutical.routeOfAdministration",
"min" : 1,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductPharmaceutical.routeOfAdministration.id",
"path" : "MedicinalProductPharmaceutical.routeOfAdministration.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MedicinalProductPharmaceutical.routeOfAdministration.extension",
"path" : "MedicinalProductPharmaceutical.routeOfAdministration.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MedicinalProductPharmaceutical.routeOfAdministration.modifierExtension",
"path" : "MedicinalProductPharmaceutical.routeOfAdministration.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MedicinalProductPharmaceutical.routeOfAdministration.code",
"path" : "MedicinalProductPharmaceutical.routeOfAdministration.code",
"short" : "Coded expression for the route",
"definition" : "Coded expression for the route.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "MedicinalProductPharmaceutical.routeOfAdministration.code",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductPharmaceutical.routeOfAdministration.firstDose",
"path" : "MedicinalProductPharmaceutical.routeOfAdministration.firstDose",
"short" : "The first dose (dose quantity) administered in humans can be specified, for a product under investigation, using a numerical value and its unit of measurement",
"definition" : "The first dose (dose quantity) administered in humans can be specified, for a product under investigation, using a numerical value and its unit of measurement.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicinalProductPharmaceutical.routeOfAdministration.firstDose",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Quantity"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductPharmaceutical.routeOfAdministration.maxSingleDose",
"path" : "MedicinalProductPharmaceutical.routeOfAdministration.maxSingleDose",
"short" : "The maximum single dose that can be administered as per the protocol of a clinical trial can be specified using a numerical value and its unit of measurement",
"definition" : "The maximum single dose that can be administered as per the protocol of a clinical trial can be specified using a numerical value and its unit of measurement.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicinalProductPharmaceutical.routeOfAdministration.maxSingleDose",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Quantity"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductPharmaceutical.routeOfAdministration.maxDosePerDay",
"path" : "MedicinalProductPharmaceutical.routeOfAdministration.maxDosePerDay",
"short" : "The maximum dose per day (maximum dose quantity to be administered in any one 24-h period) that can be administered as per the protocol referenced in the clinical trial authorisation",
"definition" : "The maximum dose per day (maximum dose quantity to be administered in any one 24-h period) that can be administered as per the protocol referenced in the clinical trial authorisation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicinalProductPharmaceutical.routeOfAdministration.maxDosePerDay",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Quantity"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductPharmaceutical.routeOfAdministration.maxDosePerTreatmentPeriod",
"path" : "MedicinalProductPharmaceutical.routeOfAdministration.maxDosePerTreatmentPeriod",
"short" : "The maximum dose per treatment period that can be administered as per the protocol referenced in the clinical trial authorisation",
"definition" : "The maximum dose per treatment period that can be administered as per the protocol referenced in the clinical trial authorisation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicinalProductPharmaceutical.routeOfAdministration.maxDosePerTreatmentPeriod",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Ratio"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductPharmaceutical.routeOfAdministration.maxTreatmentPeriod",
"path" : "MedicinalProductPharmaceutical.routeOfAdministration.maxTreatmentPeriod",
"short" : "The maximum treatment period during which an Investigational Medicinal Product can be administered as per the protocol referenced in the clinical trial authorisation",
"definition" : "The maximum treatment period during which an Investigational Medicinal Product can be administered as per the protocol referenced in the clinical trial authorisation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicinalProductPharmaceutical.routeOfAdministration.maxTreatmentPeriod",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Duration"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductPharmaceutical.routeOfAdministration.targetSpecies",
"path" : "MedicinalProductPharmaceutical.routeOfAdministration.targetSpecies",
"short" : "A species for which this route applies",
"definition" : "A species for which this route applies.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicinalProductPharmaceutical.routeOfAdministration.targetSpecies",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductPharmaceutical.routeOfAdministration.targetSpecies.id",
"path" : "MedicinalProductPharmaceutical.routeOfAdministration.targetSpecies.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MedicinalProductPharmaceutical.routeOfAdministration.targetSpecies.extension",
"path" : "MedicinalProductPharmaceutical.routeOfAdministration.targetSpecies.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MedicinalProductPharmaceutical.routeOfAdministration.targetSpecies.modifierExtension",
"path" : "MedicinalProductPharmaceutical.routeOfAdministration.targetSpecies.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MedicinalProductPharmaceutical.routeOfAdministration.targetSpecies.code",
"path" : "MedicinalProductPharmaceutical.routeOfAdministration.targetSpecies.code",
"short" : "Coded expression for the species",
"definition" : "Coded expression for the species.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "MedicinalProductPharmaceutical.routeOfAdministration.targetSpecies.code",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductPharmaceutical.routeOfAdministration.targetSpecies.withdrawalPeriod",
"path" : "MedicinalProductPharmaceutical.routeOfAdministration.targetSpecies.withdrawalPeriod",
"short" : "A species specific time during which consumption of animal product is not appropriate",
"definition" : "A species specific time during which consumption of animal product is not appropriate.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicinalProductPharmaceutical.routeOfAdministration.targetSpecies.withdrawalPeriod",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductPharmaceutical.routeOfAdministration.targetSpecies.withdrawalPeriod.id",
"path" : "MedicinalProductPharmaceutical.routeOfAdministration.targetSpecies.withdrawalPeriod.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MedicinalProductPharmaceutical.routeOfAdministration.targetSpecies.withdrawalPeriod.extension",
"path" : "MedicinalProductPharmaceutical.routeOfAdministration.targetSpecies.withdrawalPeriod.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MedicinalProductPharmaceutical.routeOfAdministration.targetSpecies.withdrawalPeriod.modifierExtension",
"path" : "MedicinalProductPharmaceutical.routeOfAdministration.targetSpecies.withdrawalPeriod.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MedicinalProductPharmaceutical.routeOfAdministration.targetSpecies.withdrawalPeriod.tissue",
"path" : "MedicinalProductPharmaceutical.routeOfAdministration.targetSpecies.withdrawalPeriod.tissue",
"short" : "Coded expression for the type of tissue for which the withdrawal period applues, e.g. meat, milk",
"definition" : "Coded expression for the type of tissue for which the withdrawal period applues, e.g. meat, milk.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "MedicinalProductPharmaceutical.routeOfAdministration.targetSpecies.withdrawalPeriod.tissue",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductPharmaceutical.routeOfAdministration.targetSpecies.withdrawalPeriod.value",
"path" : "MedicinalProductPharmaceutical.routeOfAdministration.targetSpecies.withdrawalPeriod.value",
"short" : "A value for the time",
"definition" : "A value for the time.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "MedicinalProductPharmaceutical.routeOfAdministration.targetSpecies.withdrawalPeriod.value",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "Quantity"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductPharmaceutical.routeOfAdministration.targetSpecies.withdrawalPeriod.supportingInformation",
"path" : "MedicinalProductPharmaceutical.routeOfAdministration.targetSpecies.withdrawalPeriod.supportingInformation",
"short" : "Extra information about the withdrawal period",
"definition" : "Extra information about the withdrawal period.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicinalProductPharmaceutical.routeOfAdministration.targetSpecies.withdrawalPeriod.supportingInformation",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
}]
},
"differential" : {
"element" : [{
"id" : "MedicinalProductPharmaceutical",
"path" : "MedicinalProductPharmaceutical",
"short" : "A pharmaceutical product described in terms of its composition and dose form",
"definition" : "A pharmaceutical product described in terms of its composition and dose form.",
"min" : 0,
"max" : "*"
},
{
"id" : "MedicinalProductPharmaceutical.identifier",
"path" : "MedicinalProductPharmaceutical.identifier",
"short" : "An identifier for the pharmaceutical medicinal product",
"definition" : "An identifier for the pharmaceutical medicinal product.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Identifier"
}],
"isSummary" : true
},
{
"id" : "MedicinalProductPharmaceutical.administrableDoseForm",
"path" : "MedicinalProductPharmaceutical.administrableDoseForm",
"short" : "The administrable dose form, after necessary reconstitution",
"definition" : "The administrable dose form, after necessary reconstitution.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "MedicinalProductPharmaceutical.unitOfPresentation",
"path" : "MedicinalProductPharmaceutical.unitOfPresentation",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "MedicinalProductPharmaceutical.ingredient",
"path" : "MedicinalProductPharmaceutical.ingredient",
"short" : "Ingredient",
"definition" : "Ingredient.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/MedicinalProductIngredient"]
}],
"isSummary" : true
},
{
"id" : "MedicinalProductPharmaceutical.device",
"path" : "MedicinalProductPharmaceutical.device",
"short" : "Accompanying device",
"definition" : "Accompanying device.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/DeviceDefinition"]
}],
"isSummary" : true
},
{
"id" : "MedicinalProductPharmaceutical.characteristics",
"path" : "MedicinalProductPharmaceutical.characteristics",
"short" : "Characteristics e.g. a products onset of action",
"definition" : "Characteristics e.g. a products onset of action.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"isSummary" : true
},
{
"id" : "MedicinalProductPharmaceutical.characteristics.code",
"path" : "MedicinalProductPharmaceutical.characteristics.code",
"short" : "A coded characteristic",
"definition" : "A coded characteristic.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "MedicinalProductPharmaceutical.characteristics.status",
"path" : "MedicinalProductPharmaceutical.characteristics.status",
"short" : "The status of characteristic e.g. assigned or pending",
"definition" : "The status of characteristic e.g. assigned or pending.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "MedicinalProductPharmaceutical.routeOfAdministration",
"path" : "MedicinalProductPharmaceutical.routeOfAdministration",
"short" : "The path by which the pharmaceutical product is taken into or makes contact with the body",
"definition" : "The path by which the pharmaceutical product is taken into or makes contact with the body.",
"min" : 1,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"isSummary" : true
},
{
"id" : "MedicinalProductPharmaceutical.routeOfAdministration.code",
"path" : "MedicinalProductPharmaceutical.routeOfAdministration.code",
"short" : "Coded expression for the route",
"definition" : "Coded expression for the route.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "MedicinalProductPharmaceutical.routeOfAdministration.firstDose",
"path" : "MedicinalProductPharmaceutical.routeOfAdministration.firstDose",
"short" : "The first dose (dose quantity) administered in humans can be specified, for a product under investigation, using a numerical value and its unit of measurement",
"definition" : "The first dose (dose quantity) administered in humans can be specified, for a product under investigation, using a numerical value and its unit of measurement.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Quantity"
}],
"isSummary" : true
},
{
"id" : "MedicinalProductPharmaceutical.routeOfAdministration.maxSingleDose",
"path" : "MedicinalProductPharmaceutical.routeOfAdministration.maxSingleDose",
"short" : "The maximum single dose that can be administered as per the protocol of a clinical trial can be specified using a numerical value and its unit of measurement",
"definition" : "The maximum single dose that can be administered as per the protocol of a clinical trial can be specified using a numerical value and its unit of measurement.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Quantity"
}],
"isSummary" : true
},
{
"id" : "MedicinalProductPharmaceutical.routeOfAdministration.maxDosePerDay",
"path" : "MedicinalProductPharmaceutical.routeOfAdministration.maxDosePerDay",
"short" : "The maximum dose per day (maximum dose quantity to be administered in any one 24-h period) that can be administered as per the protocol referenced in the clinical trial authorisation",
"definition" : "The maximum dose per day (maximum dose quantity to be administered in any one 24-h period) that can be administered as per the protocol referenced in the clinical trial authorisation.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Quantity"
}],
"isSummary" : true
},
{
"id" : "MedicinalProductPharmaceutical.routeOfAdministration.maxDosePerTreatmentPeriod",
"path" : "MedicinalProductPharmaceutical.routeOfAdministration.maxDosePerTreatmentPeriod",
"short" : "The maximum dose per treatment period that can be administered as per the protocol referenced in the clinical trial authorisation",
"definition" : "The maximum dose per treatment period that can be administered as per the protocol referenced in the clinical trial authorisation.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Ratio"
}],
"isSummary" : true
},
{
"id" : "MedicinalProductPharmaceutical.routeOfAdministration.maxTreatmentPeriod",
"path" : "MedicinalProductPharmaceutical.routeOfAdministration.maxTreatmentPeriod",
"short" : "The maximum treatment period during which an Investigational Medicinal Product can be administered as per the protocol referenced in the clinical trial authorisation",
"definition" : "The maximum treatment period during which an Investigational Medicinal Product can be administered as per the protocol referenced in the clinical trial authorisation.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Duration"
}],
"isSummary" : true
},
{
"id" : "MedicinalProductPharmaceutical.routeOfAdministration.targetSpecies",
"path" : "MedicinalProductPharmaceutical.routeOfAdministration.targetSpecies",
"short" : "A species for which this route applies",
"definition" : "A species for which this route applies.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"isSummary" : true
},
{
"id" : "MedicinalProductPharmaceutical.routeOfAdministration.targetSpecies.code",
"path" : "MedicinalProductPharmaceutical.routeOfAdministration.targetSpecies.code",
"short" : "Coded expression for the species",
"definition" : "Coded expression for the species.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "MedicinalProductPharmaceutical.routeOfAdministration.targetSpecies.withdrawalPeriod",
"path" : "MedicinalProductPharmaceutical.routeOfAdministration.targetSpecies.withdrawalPeriod",
"short" : "A species specific time during which consumption of animal product is not appropriate",
"definition" : "A species specific time during which consumption of animal product is not appropriate.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"isSummary" : true
},
{
"id" : "MedicinalProductPharmaceutical.routeOfAdministration.targetSpecies.withdrawalPeriod.tissue",
"path" : "MedicinalProductPharmaceutical.routeOfAdministration.targetSpecies.withdrawalPeriod.tissue",
"short" : "Coded expression for the type of tissue for which the withdrawal period applues, e.g. meat, milk",
"definition" : "Coded expression for the type of tissue for which the withdrawal period applues, e.g. meat, milk.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "MedicinalProductPharmaceutical.routeOfAdministration.targetSpecies.withdrawalPeriod.value",
"path" : "MedicinalProductPharmaceutical.routeOfAdministration.targetSpecies.withdrawalPeriod.value",
"short" : "A value for the time",
"definition" : "A value for the time.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "Quantity"
}],
"isSummary" : true
},
{
"id" : "MedicinalProductPharmaceutical.routeOfAdministration.targetSpecies.withdrawalPeriod.supportingInformation",
"path" : "MedicinalProductPharmaceutical.routeOfAdministration.targetSpecies.withdrawalPeriod.supportingInformation",
"short" : "Extra information about the withdrawal period",
"definition" : "Extra information about the withdrawal period.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true
}]
}
}
},
{
"fullUrl" : "http://hl7.org/fhir/StructureDefinition/MedicinalProductUndesirableEffect",
"resource" : {
"resourceType" : "StructureDefinition",
"id" : "MedicinalProductUndesirableEffect",
"meta" : {
"lastUpdated" : "2019-11-01T09:29:23.356+11:00"
},
"text" : {
"status" : "generated",
"div" : "Name Flags Card. Type Description & Constraints MedicinalProductUndesirableEffect ΣTU DomainResource MedicinalProductUndesirableEffect
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension subject Σ 0..* Reference(MedicinalProduct | Medication) The medication for which this is an indication
symptomConditionEffect Σ 0..1 CodeableConcept The symptom, condition or undesirable effect classification Σ 0..1 CodeableConcept Classification of the effect frequencyOfOccurrence Σ 0..1 CodeableConcept The frequency of occurrence of the effect population Σ 0..* Population The population group to which this applies
Documentation for this format
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Specialized.Medication Definition"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 0
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "anonymous"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "brr"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/MedicinalProductUndesirableEffect",
"version" : "4.0.1",
"name" : "MedicinalProductUndesirableEffect",
"status" : "draft",
"date" : "2019-11-01T09:29:23+11:00",
"publisher" : "Health Level Seven International (Biomedical Research and Regulation)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/rcrim/index.cfm"
}]
}],
"description" : "Describe the undesirable effects of the medicinal product.",
"fhirVersion" : "4.0.1",
"mapping" : [{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
}],
"kind" : "resource",
"abstract" : false,
"type" : "MedicinalProductUndesirableEffect",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "MedicinalProductUndesirableEffect",
"path" : "MedicinalProductUndesirableEffect",
"short" : "MedicinalProductUndesirableEffect",
"definition" : "Describe the undesirable effects of the medicinal product.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicinalProductUndesirableEffect",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "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",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.`div`.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
}]
},
{
"id" : "MedicinalProductUndesirableEffect.id",
"path" : "MedicinalProductUndesirableEffect.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductUndesirableEffect.meta",
"path" : "MedicinalProductUndesirableEffect.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductUndesirableEffect.implicitRules",
"path" : "MedicinalProductUndesirableEffect.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "MedicinalProductUndesirableEffect.language",
"path" : "MedicinalProductUndesirableEffect.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "MedicinalProductUndesirableEffect.text",
"path" : "MedicinalProductUndesirableEffect.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "MedicinalProductUndesirableEffect.contained",
"path" : "MedicinalProductUndesirableEffect.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MedicinalProductUndesirableEffect.extension",
"path" : "MedicinalProductUndesirableEffect.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MedicinalProductUndesirableEffect.modifierExtension",
"path" : "MedicinalProductUndesirableEffect.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MedicinalProductUndesirableEffect.subject",
"path" : "MedicinalProductUndesirableEffect.subject",
"short" : "The medication for which this is an indication",
"definition" : "The medication for which this is an indication.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicinalProductUndesirableEffect.subject",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/MedicinalProduct",
"http://hl7.org/fhir/StructureDefinition/Medication"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductUndesirableEffect.symptomConditionEffect",
"path" : "MedicinalProductUndesirableEffect.symptomConditionEffect",
"short" : "The symptom, condition or undesirable effect",
"definition" : "The symptom, condition or undesirable effect.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicinalProductUndesirableEffect.symptomConditionEffect",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductUndesirableEffect.classification",
"path" : "MedicinalProductUndesirableEffect.classification",
"short" : "Classification of the effect",
"definition" : "Classification of the effect.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicinalProductUndesirableEffect.classification",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductUndesirableEffect.frequencyOfOccurrence",
"path" : "MedicinalProductUndesirableEffect.frequencyOfOccurrence",
"short" : "The frequency of occurrence of the effect",
"definition" : "The frequency of occurrence of the effect.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicinalProductUndesirableEffect.frequencyOfOccurrence",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MedicinalProductUndesirableEffect.population",
"path" : "MedicinalProductUndesirableEffect.population",
"short" : "The population group to which this applies",
"definition" : "The population group to which this applies.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicinalProductUndesirableEffect.population",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Population"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
}]
},
"differential" : {
"element" : [{
"id" : "MedicinalProductUndesirableEffect",
"path" : "MedicinalProductUndesirableEffect",
"short" : "MedicinalProductUndesirableEffect",
"definition" : "Describe the undesirable effects of the medicinal product.",
"min" : 0,
"max" : "*"
},
{
"id" : "MedicinalProductUndesirableEffect.subject",
"path" : "MedicinalProductUndesirableEffect.subject",
"short" : "The medication for which this is an indication",
"definition" : "The medication for which this is an indication.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/MedicinalProduct",
"http://hl7.org/fhir/StructureDefinition/Medication"]
}],
"isSummary" : true
},
{
"id" : "MedicinalProductUndesirableEffect.symptomConditionEffect",
"path" : "MedicinalProductUndesirableEffect.symptomConditionEffect",
"short" : "The symptom, condition or undesirable effect",
"definition" : "The symptom, condition or undesirable effect.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "MedicinalProductUndesirableEffect.classification",
"path" : "MedicinalProductUndesirableEffect.classification",
"short" : "Classification of the effect",
"definition" : "Classification of the effect.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "MedicinalProductUndesirableEffect.frequencyOfOccurrence",
"path" : "MedicinalProductUndesirableEffect.frequencyOfOccurrence",
"short" : "The frequency of occurrence of the effect",
"definition" : "The frequency of occurrence of the effect.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "MedicinalProductUndesirableEffect.population",
"path" : "MedicinalProductUndesirableEffect.population",
"short" : "The population group to which this applies",
"definition" : "The population group to which this applies.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Population"
}],
"isSummary" : true
}]
}
}
},
{
"fullUrl" : "http://hl7.org/fhir/StructureDefinition/MessageDefinition",
"resource" : {
"resourceType" : "StructureDefinition",
"id" : "MessageDefinition",
"meta" : {
"lastUpdated" : "2019-11-01T09:29:23.356+11:00"
},
"text" : {
"status" : "generated",
"div" : "Name Flags Card. Type Description & Constraints MessageDefinition ITU 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 url Σ 0..1 uri Business Identifier for a given MessageDefinition identifier Σ 0..* Identifier Primary key for the message definition on a given server
version Σ 0..1 string Business version of the message definition name ΣI 0..1 string Name for this message definition (computer friendly) title Σ 0..1 string Name for this message definition (human friendly) replaces Σ 0..* canonical(MessageDefinition) Takes the place of
status ?!Σ 1..1 code draft | active | retired | unknown
PublicationStatus (Required) experimental Σ 0..1 boolean For testing purposes, not real usage date Σ 1..1 dateTime Date last changed publisher Σ 0..1 string Name of the publisher (organization or individual) contact Σ 0..* ContactDetail Contact details for the publisher
description Σ 0..1 markdown Natural language description of the message definition useContext Σ 0..* UsageContext The context that the content is intended to support
jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for message definition (if applicable)
Jurisdiction (Extensible)
purpose Σ 0..1 markdown Why this message definition is defined copyright 0..1 markdown Use and/or publishing restrictions base Σ 0..1 canonical(MessageDefinition) Definition this one is based on parent Σ 0..* canonical(ActivityDefinition | PlanDefinition) Protocol/workflow this is part of
event[x] Σ 1..1 Event code or link to the EventDefinition
MessageEvent (Example) eventCoding Coding eventUri uri category Σ 0..1 code consequence | currency | notification
MessageSignificanceCategory (Required) focus ΣI 0..* BackboneElement Resource(s) that are the subject of the event
+ Rule: Max must be postive int or *
code Σ 1..1 code Type of resource
ResourceType (Required) profile 0..1 canonical(StructureDefinition) Profile that must be adhered to by focus min Σ 1..1 unsignedInt Minimum number of focuses of this type max I 0..1 string Maximum number of focuses of this type responseRequired 0..1 code always | on-error | never | on-success
messageheader-response-request (Required) allowedResponse 0..* BackboneElement Responses to this message
message 1..1 canonical(MessageDefinition) Reference to allowed message definition response situation 0..1 markdown When should this response be used graph 0..* canonical(GraphDefinition) Canonical reference to a GraphDefinition
Documentation for this format
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Foundation.Conformance"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 1
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "anonymous"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "inm"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/MessageDefinition",
"version" : "4.0.1",
"name" : "MessageDefinition",
"status" : "draft",
"date" : "2019-11-01T09:29:23+11:00",
"publisher" : "Health Level Seven International (Infrastructure And Messaging)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/special/committees/inm/index.cfm"
}]
}],
"description" : "Defines the characteristics of a message that can be shared between systems, including the type of event that initiates the message, the content to be transmitted and what response(s), if any, are permitted.",
"purpose" : "Allows messages to be defined once and re-used across systems.",
"fhirVersion" : "4.0.1",
"mapping" : [{
"identity" : "v2",
"uri" : "http://hl7.org/v2",
"name" : "HL7 v2 Mapping"
},
{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
},
{
"identity" : "workflow",
"uri" : "http://hl7.org/fhir/workflow",
"name" : "Workflow Pattern"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/fivews",
"name" : "FiveWs Pattern Mapping"
},
{
"identity" : "objimpl",
"uri" : "http://hl7.org/fhir/object-implementation",
"name" : "Object Implementation Information"
}],
"kind" : "resource",
"abstract" : false,
"type" : "MessageDefinition",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"_baseDefinition" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-codegen-super",
"valueString" : "MetadataResource"
}]
},
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "MessageDefinition",
"path" : "MessageDefinition",
"short" : "A resource that defines a type of message that can be exchanged between systems",
"definition" : "Defines the characteristics of a message that can be shared between systems, including the type of event that initiates the message, the content to be transmitted and what response(s), if any, are permitted.",
"comment" : "This would be a MIF-level artifact.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MessageDefinition",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "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",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.`div`.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "msd-0",
"severity" : "warning",
"human" : "Name should be usable as an identifier for the module by machine processing applications such as code generation",
"expression" : "name.matches('[A-Z]([A-Za-z0-9_]){0,254}')",
"xpath" : "not(exists(f:name/@value)) or matches(f:name/@value, '[A-Z]([A-Za-z0-9_]){0,254}')"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "v2",
"map" : "N/A"
},
{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MessageDefinition.id",
"path" : "MessageDefinition.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MessageDefinition.meta",
"path" : "MessageDefinition.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MessageDefinition.implicitRules",
"path" : "MessageDefinition.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "MessageDefinition.language",
"path" : "MessageDefinition.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "MessageDefinition.text",
"path" : "MessageDefinition.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "MessageDefinition.contained",
"path" : "MessageDefinition.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MessageDefinition.extension",
"path" : "MessageDefinition.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MessageDefinition.modifierExtension",
"path" : "MessageDefinition.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MessageDefinition.url",
"path" : "MessageDefinition.url",
"short" : "Business Identifier for a given MessageDefinition",
"definition" : "The business identifier that is used to reference the MessageDefinition and *is* expected to be consistent from server to server.",
"comment" : "Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.\n\nThe determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions). \n\nIn some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.",
"requirements" : "Allows the message definition to be referenced by a single globally unique identifier.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MessageDefinition.url",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.url"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
}]
},
{
"id" : "MessageDefinition.identifier",
"path" : "MessageDefinition.identifier",
"short" : "Primary key for the message definition on a given server",
"definition" : "A formal identifier that is used to identify this message definition when it is represented in other formats, or referenced in a specification, model, design or an instance.",
"comment" : "Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this message definition outside of FHIR, where it is not possible to use the logical URI.",
"requirements" : "Allows externally provided and/or usable business identifiers to be easily associated with the module.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MessageDefinition.identifier",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Identifier"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.identifier"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "MessageDefinition.version",
"path" : "MessageDefinition.version",
"short" : "Business version of the message definition",
"definition" : "The identifier that is used to identify this version of the message definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the message definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.",
"comment" : "There may be different message definition instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the message definition with the format [url]|[version].",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MessageDefinition.version",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.version"
},
{
"identity" : "w5",
"map" : "FiveWs.version"
}]
},
{
"id" : "MessageDefinition.name",
"path" : "MessageDefinition.name",
"short" : "Name for this message definition (computer friendly)",
"definition" : "A natural language name identifying the message definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.",
"comment" : "The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.",
"requirements" : "Support human navigation and code generation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MessageDefinition.name",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"condition" : ["inv-0"],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MessageDefinition.title",
"path" : "MessageDefinition.title",
"short" : "Name for this message definition (human friendly)",
"definition" : "A short, descriptive, user-friendly title for the message definition.",
"comment" : "This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MessageDefinition.title",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.title"
}]
},
{
"id" : "MessageDefinition.replaces",
"path" : "MessageDefinition.replaces",
"short" : "Takes the place of",
"definition" : "A MessageDefinition that is superseded by this definition.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MessageDefinition.replaces",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/MessageDefinition"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MessageDefinition.status",
"path" : "MessageDefinition.status",
"short" : "draft | active | retired | unknown",
"definition" : "The status of this message definition. Enables tracking the life-cycle of the content.",
"comment" : "Allows filtering of message definitions that are appropriate for use versus not.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "MessageDefinition.status",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This is labeled as \"Is Modifier\" because applications should not use a retired {{title}} without due consideration",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "PublicationStatus"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "The lifecycle status of an artifact.",
"valueSet" : "http://hl7.org/fhir/ValueSet/publication-status|4.0.1"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.status"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
}]
},
{
"id" : "MessageDefinition.experimental",
"path" : "MessageDefinition.experimental",
"short" : "For testing purposes, not real usage",
"definition" : "A Boolean value to indicate that this message definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.",
"comment" : "Allows filtering of message definitions that are appropriate for use versus not.",
"requirements" : "Enables experimental content to be developed following the same lifecycle that would be used for a production-level message definition.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MessageDefinition.experimental",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.experimental"
},
{
"identity" : "w5",
"map" : "FiveWs.class"
}]
},
{
"id" : "MessageDefinition.date",
"path" : "MessageDefinition.date",
"short" : "Date last changed",
"definition" : "The date (and optionally time) when the message definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the message definition changes.",
"comment" : "Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the message definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.",
"alias" : ["Revision Date"],
"min" : 1,
"max" : "1",
"base" : {
"path" : "MessageDefinition.date",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.date"
},
{
"identity" : "w5",
"map" : "FiveWs.recorded"
}]
},
{
"id" : "MessageDefinition.publisher",
"path" : "MessageDefinition.publisher",
"short" : "Name of the publisher (organization or individual)",
"definition" : "The name of the organization or individual that published the message definition.",
"comment" : "Usually an organization but may be an individual. The publisher (or steward) of the message definition is the organization or individual primarily responsible for the maintenance and upkeep of the message definition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the message definition. This item SHOULD be populated unless the information is available from context.",
"requirements" : "Helps establish the \"authority/credibility\" of the message definition. May also allow for contact.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MessageDefinition.publisher",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.publisher"
},
{
"identity" : "w5",
"map" : "FiveWs.witness"
}]
},
{
"id" : "MessageDefinition.contact",
"path" : "MessageDefinition.contact",
"short" : "Contact details for the publisher",
"definition" : "Contact details to assist a user in finding and communicating with the publisher.",
"comment" : "May be a web site, an email address, a telephone number, etc.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MessageDefinition.contact",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "ContactDetail"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.contact"
}]
},
{
"id" : "MessageDefinition.description",
"path" : "MessageDefinition.description",
"short" : "Natural language description of the message definition",
"definition" : "A free text natural language description of the message definition from a consumer's perspective.",
"comment" : "This description can be used to capture details such as why the message definition was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the message definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the message definition is presumed to be the predominant language in the place the message definition was created).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MessageDefinition.description",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "markdown"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.description"
}]
},
{
"id" : "MessageDefinition.useContext",
"path" : "MessageDefinition.useContext",
"short" : "The context that the content is intended to support",
"definition" : "The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate message definition instances.",
"comment" : "When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.",
"requirements" : "Assist in searching for appropriate content.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MessageDefinition.useContext",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "UsageContext"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.useContext"
}]
},
{
"id" : "MessageDefinition.jurisdiction",
"path" : "MessageDefinition.jurisdiction",
"short" : "Intended jurisdiction for message definition (if applicable)",
"definition" : "A legal or geographic region in which the message definition is intended to be used.",
"comment" : "It may be possible for the message definition to be used in jurisdictions other than those for which it was originally designed or intended.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MessageDefinition.jurisdiction",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Jurisdiction"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "extensible",
"description" : "Countries and regions within which this artifact is targeted for use.",
"valueSet" : "http://hl7.org/fhir/ValueSet/jurisdiction"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.jurisdiction"
}]
},
{
"id" : "MessageDefinition.purpose",
"path" : "MessageDefinition.purpose",
"short" : "Why this message definition is defined",
"definition" : "Explanation of why this message definition is needed and why it has been designed as it has.",
"comment" : "This element does not describe the usage of the message definition. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this message definition.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MessageDefinition.purpose",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "markdown"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.purpose"
},
{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "MessageDefinition.copyright",
"path" : "MessageDefinition.copyright",
"short" : "Use and/or publishing restrictions",
"definition" : "A copyright statement relating to the message definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the message definition.",
"requirements" : "Consumers must be able to determine any legal restrictions on the use of the message definition and/or its content.",
"alias" : ["License",
"Restrictions"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "MessageDefinition.copyright",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "markdown"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.copyright"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "MessageDefinition.base",
"path" : "MessageDefinition.base",
"short" : "Definition this one is based on",
"definition" : "The MessageDefinition that is the basis for the contents of this resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MessageDefinition.base",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/MessageDefinition"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MessageDefinition.parent",
"path" : "MessageDefinition.parent",
"short" : "Protocol/workflow this is part of",
"definition" : "Identifies a protocol or workflow that this MessageDefinition represents a step in.",
"comment" : "It should be possible to use MessageDefinition to describe a message to be used by certain steps in a particular protocol as part of a PlanDefinition or ActivityDefinition.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MessageDefinition.parent",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ActivityDefinition",
"http://hl7.org/fhir/StructureDefinition/PlanDefinition"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MessageDefinition.event[x]",
"path" : "MessageDefinition.event[x]",
"short" : "Event code or link to the EventDefinition",
"definition" : "Event code or link to the EventDefinition.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "MessageDefinition.event[x]",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "Coding"
},
{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MessageEvent"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "example",
"description" : "One of the message events defined as part of this version of FHIR.",
"valueSet" : "http://hl7.org/fhir/ValueSet/message-events"
}
},
{
"id" : "MessageDefinition.category",
"path" : "MessageDefinition.category",
"short" : "consequence | currency | notification",
"definition" : "The impact of the content of the message.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MessageDefinition.category",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MessageSignificanceCategory"
}],
"strength" : "required",
"description" : "The impact of the content of a message.",
"valueSet" : "http://hl7.org/fhir/ValueSet/message-significance-category|4.0.1"
}
},
{
"id" : "MessageDefinition.focus",
"path" : "MessageDefinition.focus",
"short" : "Resource(s) that are the subject of the event",
"definition" : "Identifies the resource (or resources) that are being addressed by the event. For example, the Encounter for an admit message or two Account records for a merge.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MessageDefinition.focus",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "md-1",
"severity" : "error",
"human" : "Max must be postive int or *",
"expression" : "max='*' or (max.toInteger() > 0)",
"xpath" : "f:max/@value='*' or number(f:max/@value) > 0"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MessageDefinition.focus.id",
"path" : "MessageDefinition.focus.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MessageDefinition.focus.extension",
"path" : "MessageDefinition.focus.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MessageDefinition.focus.modifierExtension",
"path" : "MessageDefinition.focus.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MessageDefinition.focus.code",
"path" : "MessageDefinition.focus.code",
"short" : "Type of resource",
"definition" : "The kind of resource that must be the focus for this message.",
"comment" : "Multiple focuses addressing different resources may occasionally occur. E.g. to link or unlink a resource from a particular account or encounter, etc.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "MessageDefinition.focus.code",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ResourceType"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "One of the resource types defined as part of this version of FHIR.",
"valueSet" : "http://hl7.org/fhir/ValueSet/resource-types|4.0.1"
}
},
{
"id" : "MessageDefinition.focus.profile",
"path" : "MessageDefinition.focus.profile",
"short" : "Profile that must be adhered to by focus",
"definition" : "A profile that reflects constraints for the focal resource (and potentially for related resources).",
"comment" : "This should be present for most message definitions. However, if the message focus is only a single resource and there is no need to include referenced resources or otherwise enforce the presence of particular elements, it can be omitted.",
"requirements" : "This profile allows setting boundaries for what content must appear within the message bundle vs. outside based on the declared aggregation constraints on referenced resources on this and related profiles.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MessageDefinition.focus.profile",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/StructureDefinition"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "MessageDefinition.focus.min",
"path" : "MessageDefinition.focus.min",
"short" : "Minimum number of focuses of this type",
"definition" : "Identifies the minimum number of resources of this type that must be pointed to by a message in order for it to be valid against this MessageDefinition.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "MessageDefinition.focus.min",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "unsignedInt"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MessageDefinition.focus.max",
"path" : "MessageDefinition.focus.max",
"short" : "Maximum number of focuses of this type",
"definition" : "Identifies the maximum number of resources of this type that must be pointed to by a message in order for it to be valid against this MessageDefinition.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MessageDefinition.focus.max",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"condition" : ["md-1"],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "MessageDefinition.responseRequired",
"path" : "MessageDefinition.responseRequired",
"short" : "always | on-error | never | on-success",
"definition" : "Declare at a message definition level whether a response is required or only upon error or success, or never.",
"comment" : "This enables the capability currently available through MSH-16 (Application Level acknowledgement) in HL7 Version 2 to declare at a message instance level whether a response is required or only upon error or success, or never.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MessageDefinition.responseRequired",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"example" : [{
"label" : "General",
"valueCode" : "always"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "messageheader-response-request"
}],
"strength" : "required",
"description" : "HL7-defined table of codes which identify conditions under which acknowledgments are required to be returned in response to a message.",
"valueSet" : "http://hl7.org/fhir/ValueSet/messageheader-response-request|4.0.1"
},
"mapping" : [{
"identity" : "v2",
"map" : "MSH-16"
}]
},
{
"id" : "MessageDefinition.allowedResponse",
"path" : "MessageDefinition.allowedResponse",
"short" : "Responses to this message",
"definition" : "Indicates what types of messages may be sent as an application-level response to this message.",
"comment" : "This indicates an application level response to \"close\" a transaction implicit in a particular request message. To define a complete workflow scenario, look to the [[PlanDefinition]] resource which allows the definition of complex orchestrations, conditionality, etc.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MessageDefinition.allowedResponse",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "MessageDefinition.allowedResponse.id",
"path" : "MessageDefinition.allowedResponse.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MessageDefinition.allowedResponse.extension",
"path" : "MessageDefinition.allowedResponse.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MessageDefinition.allowedResponse.modifierExtension",
"path" : "MessageDefinition.allowedResponse.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MessageDefinition.allowedResponse.message",
"path" : "MessageDefinition.allowedResponse.message",
"short" : "Reference to allowed message definition response",
"definition" : "A reference to the message definition that must be adhered to by this supported response.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "MessageDefinition.allowedResponse.message",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/MessageDefinition"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "MessageDefinition.allowedResponse.situation",
"path" : "MessageDefinition.allowedResponse.situation",
"short" : "When should this response be used",
"definition" : "Provides a description of the circumstances in which this response should be used (as opposed to one of the alternative responses).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MessageDefinition.allowedResponse.situation",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "markdown"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "MessageDefinition.graph",
"path" : "MessageDefinition.graph",
"short" : "Canonical reference to a GraphDefinition",
"definition" : "Canonical reference to a GraphDefinition. If a URL is provided, it is the canonical reference to a [GraphDefinition](graphdefinition.html) 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.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MessageDefinition.graph",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/GraphDefinition"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
}]
},
"differential" : {
"element" : [{
"id" : "MessageDefinition",
"path" : "MessageDefinition",
"short" : "A resource that defines a type of message that can be exchanged between systems",
"definition" : "Defines the characteristics of a message that can be shared between systems, including the type of event that initiates the message, the content to be transmitted and what response(s), if any, are permitted.",
"comment" : "This would be a MIF-level artifact.",
"min" : 0,
"max" : "*",
"constraint" : [{
"key" : "msd-0",
"severity" : "warning",
"human" : "Name should be usable as an identifier for the module by machine processing applications such as code generation",
"expression" : "name.matches('[A-Z]([A-Za-z0-9_]){0,254}')",
"xpath" : "not(exists(f:name/@value)) or matches(f:name/@value, '[A-Z]([A-Za-z0-9_]){0,254}')"
}],
"mapping" : [{
"identity" : "v2",
"map" : "N/A"
},
{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MessageDefinition.url",
"path" : "MessageDefinition.url",
"short" : "Business Identifier for a given MessageDefinition",
"definition" : "The business identifier that is used to reference the MessageDefinition and *is* expected to be consistent from server to server.",
"comment" : "Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.\n\nThe determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions). \n\nIn some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.",
"requirements" : "Allows the message definition to be referenced by a single globally unique identifier.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "uri"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.url"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
}]
},
{
"id" : "MessageDefinition.identifier",
"path" : "MessageDefinition.identifier",
"short" : "Primary key for the message definition on a given server",
"definition" : "A formal identifier that is used to identify this message definition when it is represented in other formats, or referenced in a specification, model, design or an instance.",
"comment" : "Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this message definition outside of FHIR, where it is not possible to use the logical URI.",
"requirements" : "Allows externally provided and/or usable business identifiers to be easily associated with the module.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Identifier"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.identifier"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "MessageDefinition.version",
"path" : "MessageDefinition.version",
"short" : "Business version of the message definition",
"definition" : "The identifier that is used to identify this version of the message definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the message definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.",
"comment" : "There may be different message definition instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the message definition with the format [url]|[version].",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.version"
},
{
"identity" : "w5",
"map" : "FiveWs.version"
}]
},
{
"id" : "MessageDefinition.name",
"path" : "MessageDefinition.name",
"short" : "Name for this message definition (computer friendly)",
"definition" : "A natural language name identifying the message definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.",
"comment" : "The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.",
"requirements" : "Support human navigation and code generation.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"condition" : ["inv-0"],
"isSummary" : true
},
{
"id" : "MessageDefinition.title",
"path" : "MessageDefinition.title",
"short" : "Name for this message definition (human friendly)",
"definition" : "A short, descriptive, user-friendly title for the message definition.",
"comment" : "This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.title"
}]
},
{
"id" : "MessageDefinition.replaces",
"path" : "MessageDefinition.replaces",
"short" : "Takes the place of",
"definition" : "A MessageDefinition that is superseded by this definition.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/MessageDefinition"]
}],
"isSummary" : true
},
{
"id" : "MessageDefinition.status",
"path" : "MessageDefinition.status",
"short" : "draft | active | retired | unknown",
"definition" : "The status of this message definition. Enables tracking the life-cycle of the content.",
"comment" : "Allows filtering of message definitions that are appropriate for use versus not.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isModifier" : true,
"isModifierReason" : "This is labeled as \"Is Modifier\" because applications should not use a retired {{title}} without due consideration",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "PublicationStatus"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "The lifecycle status of an artifact.",
"valueSet" : "http://hl7.org/fhir/ValueSet/publication-status|4.0.1"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.status"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
}]
},
{
"id" : "MessageDefinition.experimental",
"path" : "MessageDefinition.experimental",
"short" : "For testing purposes, not real usage",
"definition" : "A Boolean value to indicate that this message definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.",
"comment" : "Allows filtering of message definitions that are appropriate for use versus not.",
"requirements" : "Enables experimental content to be developed following the same lifecycle that would be used for a production-level message definition.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "boolean"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.experimental"
},
{
"identity" : "w5",
"map" : "FiveWs.class"
}]
},
{
"id" : "MessageDefinition.date",
"path" : "MessageDefinition.date",
"short" : "Date last changed",
"definition" : "The date (and optionally time) when the message definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the message definition changes.",
"comment" : "Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the message definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.",
"alias" : ["Revision Date"],
"min" : 1,
"max" : "1",
"type" : [{
"code" : "dateTime"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.date"
},
{
"identity" : "w5",
"map" : "FiveWs.recorded"
}]
},
{
"id" : "MessageDefinition.publisher",
"path" : "MessageDefinition.publisher",
"short" : "Name of the publisher (organization or individual)",
"definition" : "The name of the organization or individual that published the message definition.",
"comment" : "Usually an organization but may be an individual. The publisher (or steward) of the message definition is the organization or individual primarily responsible for the maintenance and upkeep of the message definition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the message definition. This item SHOULD be populated unless the information is available from context.",
"requirements" : "Helps establish the \"authority/credibility\" of the message definition. May also allow for contact.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.publisher"
},
{
"identity" : "w5",
"map" : "FiveWs.witness"
}]
},
{
"id" : "MessageDefinition.contact",
"path" : "MessageDefinition.contact",
"short" : "Contact details for the publisher",
"definition" : "Contact details to assist a user in finding and communicating with the publisher.",
"comment" : "May be a web site, an email address, a telephone number, etc.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "ContactDetail"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.contact"
}]
},
{
"id" : "MessageDefinition.description",
"path" : "MessageDefinition.description",
"short" : "Natural language description of the message definition",
"definition" : "A free text natural language description of the message definition from a consumer's perspective.",
"comment" : "This description can be used to capture details such as why the message definition was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the message definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the message definition is presumed to be the predominant language in the place the message definition was created).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "markdown"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.description"
}]
},
{
"id" : "MessageDefinition.useContext",
"path" : "MessageDefinition.useContext",
"short" : "The context that the content is intended to support",
"definition" : "The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate message definition instances.",
"comment" : "When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.",
"requirements" : "Assist in searching for appropriate content.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "UsageContext"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.useContext"
}]
},
{
"id" : "MessageDefinition.jurisdiction",
"path" : "MessageDefinition.jurisdiction",
"short" : "Intended jurisdiction for message definition (if applicable)",
"definition" : "A legal or geographic region in which the message definition is intended to be used.",
"comment" : "It may be possible for the message definition to be used in jurisdictions other than those for which it was originally designed or intended.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Jurisdiction"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "extensible",
"description" : "Countries and regions within which this artifact is targeted for use.",
"valueSet" : "http://hl7.org/fhir/ValueSet/jurisdiction"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.jurisdiction"
}]
},
{
"id" : "MessageDefinition.purpose",
"path" : "MessageDefinition.purpose",
"short" : "Why this message definition is defined",
"definition" : "Explanation of why this message definition is needed and why it has been designed as it has.",
"comment" : "This element does not describe the usage of the message definition. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this message definition.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "markdown"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.purpose"
},
{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "MessageDefinition.copyright",
"path" : "MessageDefinition.copyright",
"short" : "Use and/or publishing restrictions",
"definition" : "A copyright statement relating to the message definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the message definition.",
"requirements" : "Consumers must be able to determine any legal restrictions on the use of the message definition and/or its content.",
"alias" : ["License",
"Restrictions"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "markdown"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.copyright"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "MessageDefinition.base",
"path" : "MessageDefinition.base",
"short" : "Definition this one is based on",
"definition" : "The MessageDefinition that is the basis for the contents of this resource.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/MessageDefinition"]
}],
"isSummary" : true
},
{
"id" : "MessageDefinition.parent",
"path" : "MessageDefinition.parent",
"short" : "Protocol/workflow this is part of",
"definition" : "Identifies a protocol or workflow that this MessageDefinition represents a step in.",
"comment" : "It should be possible to use MessageDefinition to describe a message to be used by certain steps in a particular protocol as part of a PlanDefinition or ActivityDefinition.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ActivityDefinition",
"http://hl7.org/fhir/StructureDefinition/PlanDefinition"]
}],
"isSummary" : true
},
{
"id" : "MessageDefinition.event[x]",
"path" : "MessageDefinition.event[x]",
"short" : "Event code or link to the EventDefinition",
"definition" : "Event code or link to the EventDefinition.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "Coding"
},
{
"code" : "uri"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MessageEvent"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "example",
"description" : "One of the message events defined as part of this version of FHIR.",
"valueSet" : "http://hl7.org/fhir/ValueSet/message-events"
}
},
{
"id" : "MessageDefinition.category",
"path" : "MessageDefinition.category",
"short" : "consequence | currency | notification",
"definition" : "The impact of the content of the message.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MessageSignificanceCategory"
}],
"strength" : "required",
"description" : "The impact of the content of a message.",
"valueSet" : "http://hl7.org/fhir/ValueSet/message-significance-category|4.0.1"
}
},
{
"id" : "MessageDefinition.focus",
"path" : "MessageDefinition.focus",
"short" : "Resource(s) that are the subject of the event",
"definition" : "Identifies the resource (or resources) that are being addressed by the event. For example, the Encounter for an admit message or two Account records for a merge.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "md-1",
"severity" : "error",
"human" : "Max must be postive int or *",
"expression" : "max='*' or (max.toInteger() > 0)",
"xpath" : "f:max/@value='*' or number(f:max/@value) > 0"
}],
"isSummary" : true
},
{
"id" : "MessageDefinition.focus.code",
"path" : "MessageDefinition.focus.code",
"short" : "Type of resource",
"definition" : "The kind of resource that must be the focus for this message.",
"comment" : "Multiple focuses addressing different resources may occasionally occur. E.g. to link or unlink a resource from a particular account or encounter, etc.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ResourceType"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "One of the resource types defined as part of this version of FHIR.",
"valueSet" : "http://hl7.org/fhir/ValueSet/resource-types|4.0.1"
}
},
{
"id" : "MessageDefinition.focus.profile",
"path" : "MessageDefinition.focus.profile",
"short" : "Profile that must be adhered to by focus",
"definition" : "A profile that reflects constraints for the focal resource (and potentially for related resources).",
"comment" : "This should be present for most message definitions. However, if the message focus is only a single resource and there is no need to include referenced resources or otherwise enforce the presence of particular elements, it can be omitted.",
"requirements" : "This profile allows setting boundaries for what content must appear within the message bundle vs. outside based on the declared aggregation constraints on referenced resources on this and related profiles.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/StructureDefinition"]
}]
},
{
"id" : "MessageDefinition.focus.min",
"path" : "MessageDefinition.focus.min",
"short" : "Minimum number of focuses of this type",
"definition" : "Identifies the minimum number of resources of this type that must be pointed to by a message in order for it to be valid against this MessageDefinition.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "unsignedInt"
}],
"isSummary" : true
},
{
"id" : "MessageDefinition.focus.max",
"path" : "MessageDefinition.focus.max",
"short" : "Maximum number of focuses of this type",
"definition" : "Identifies the maximum number of resources of this type that must be pointed to by a message in order for it to be valid against this MessageDefinition.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"condition" : ["md-1"]
},
{
"id" : "MessageDefinition.responseRequired",
"path" : "MessageDefinition.responseRequired",
"short" : "always | on-error | never | on-success",
"definition" : "Declare at a message definition level whether a response is required or only upon error or success, or never.",
"comment" : "This enables the capability currently available through MSH-16 (Application Level acknowledgement) in HL7 Version 2 to declare at a message instance level whether a response is required or only upon error or success, or never.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "code"
}],
"example" : [{
"label" : "General",
"valueCode" : "always"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "messageheader-response-request"
}],
"strength" : "required",
"description" : "HL7-defined table of codes which identify conditions under which acknowledgments are required to be returned in response to a message.",
"valueSet" : "http://hl7.org/fhir/ValueSet/messageheader-response-request|4.0.1"
},
"mapping" : [{
"identity" : "v2",
"map" : "MSH-16"
}]
},
{
"id" : "MessageDefinition.allowedResponse",
"path" : "MessageDefinition.allowedResponse",
"short" : "Responses to this message",
"definition" : "Indicates what types of messages may be sent as an application-level response to this message.",
"comment" : "This indicates an application level response to \"close\" a transaction implicit in a particular request message. To define a complete workflow scenario, look to the [[PlanDefinition]] resource which allows the definition of complex orchestrations, conditionality, etc.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "MessageDefinition.allowedResponse.message",
"path" : "MessageDefinition.allowedResponse.message",
"short" : "Reference to allowed message definition response",
"definition" : "A reference to the message definition that must be adhered to by this supported response.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/MessageDefinition"]
}]
},
{
"id" : "MessageDefinition.allowedResponse.situation",
"path" : "MessageDefinition.allowedResponse.situation",
"short" : "When should this response be used",
"definition" : "Provides a description of the circumstances in which this response should be used (as opposed to one of the alternative responses).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "markdown"
}]
},
{
"id" : "MessageDefinition.graph",
"path" : "MessageDefinition.graph",
"short" : "Canonical reference to a GraphDefinition",
"definition" : "Canonical reference to a GraphDefinition. If a URL is provided, it is the canonical reference to a [GraphDefinition](graphdefinition.html) 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.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/GraphDefinition"]
}]
}]
}
}
},
{
"fullUrl" : "http://hl7.org/fhir/StructureDefinition/MessageHeader",
"resource" : {
"resourceType" : "StructureDefinition",
"id" : "MessageHeader",
"meta" : {
"lastUpdated" : "2019-11-01T09:29:23.356+11:00"
},
"text" : {
"status" : "generated",
"div" : "Name Flags Card. Type Description & Constraints MessageHeader Σ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 event[x] Σ 1..1 Code for the event this message represents or link to event definition
MessageEvent (Example) eventCoding Coding eventUri uri destination Σ 0..* BackboneElement Message destination application(s)
name Σ 0..1 string Name of system target Σ 0..1 Reference(Device) Particular delivery destination within the destination endpoint Σ 1..1 url Actual destination address or id receiver Σ 0..1 Reference(Practitioner | PractitionerRole | Organization) Intended "real-world" recipient for the data sender Σ 0..1 Reference(Practitioner | PractitionerRole | Organization) Real world sender of the message enterer Σ 0..1 Reference(Practitioner | PractitionerRole) The source of the data entry author Σ 0..1 Reference(Practitioner | PractitionerRole) The source of the decision source Σ 1..1 BackboneElement Message source application name Σ 0..1 string Name of system software Σ 0..1 string Name of software running the system version Σ 0..1 string Version of software running contact Σ 0..1 ContactPoint Human contact for problems endpoint Σ 1..1 url Actual message source address or id responsible Σ 0..1 Reference(Practitioner | PractitionerRole | Organization) Final responsibility for event reason Σ 0..1 CodeableConcept Cause of event
Example Message Reason Codes (Example) response Σ 0..1 BackboneElement If this is a reply to prior message identifier Σ 1..1 id Id of original message code Σ 1..1 code ok | transient-error | fatal-error
ResponseType (Required) details Σ 0..1 Reference(OperationOutcome) Specific list of hints/warnings/errors focus Σ 0..* Reference(Any) The actual content of the message
definition Σ 0..1 canonical(MessageDefinition) Link to the definition for this message
Documentation for this format
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Foundation.Other"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 4
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "not-classified"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "inm"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/MessageHeader",
"version" : "4.0.1",
"name" : "MessageHeader",
"status" : "draft",
"date" : "2019-11-01T09:29:23+11:00",
"publisher" : "Health Level Seven International (Infrastructure And Messaging)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/special/committees/inm/index.cfm"
}]
}],
"description" : "The header for a message exchange that is either requesting or responding to an action. The reference(s) that are the subject of the action as well as other information related to the action are typically transmitted in a bundle in which the MessageHeader resource instance is the first resource in the bundle.",
"purpose" : "Many implementations are not prepared to use REST and need a messaging based infrastructure.",
"fhirVersion" : "4.0.1",
"mapping" : [{
"identity" : "v2",
"uri" : "http://hl7.org/v2",
"name" : "HL7 v2 Mapping"
},
{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/fivews",
"name" : "FiveWs Pattern Mapping"
}],
"kind" : "resource",
"abstract" : false,
"type" : "MessageHeader",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "MessageHeader",
"path" : "MessageHeader",
"short" : "A resource that describes a message that is exchanged between systems",
"definition" : "The header for a message exchange that is either requesting or responding to an action. The reference(s) that are the subject of the action as well as other information related to the action are typically transmitted in a bundle in which the MessageHeader resource instance is the first resource in the bundle.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MessageHeader",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "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",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.`div`.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "v2",
"map" : "MSH / MSA / ERR"
},
{
"identity" : "rim",
"map" : "Message"
}]
},
{
"id" : "MessageHeader.id",
"path" : "MessageHeader.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MessageHeader.meta",
"path" : "MessageHeader.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MessageHeader.implicitRules",
"path" : "MessageHeader.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "MessageHeader.language",
"path" : "MessageHeader.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "MessageHeader.text",
"path" : "MessageHeader.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "MessageHeader.contained",
"path" : "MessageHeader.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MessageHeader.extension",
"path" : "MessageHeader.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MessageHeader.modifierExtension",
"path" : "MessageHeader.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MessageHeader.event[x]",
"path" : "MessageHeader.event[x]",
"short" : "Code for the event this message represents or link to event definition",
"definition" : "Code that identifies the event this message represents and connects it with its definition. Events defined as part of the FHIR specification have the system value \"http://terminology.hl7.org/CodeSystem/message-events\". Alternatively uri to the EventDefinition.",
"comment" : "The time of the event will be found in the focus resource. The time of the message will be found in [Bundle.timestamp](bundle-definitions.html#Bundle.timestamp).",
"requirements" : "Drives the behavior associated with this message.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "MessageHeader.event[x]",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "Coding"
},
{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MessageEvent"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "example",
"description" : "One of the message events defined as part of this version of FHIR.",
"valueSet" : "http://hl7.org/fhir/ValueSet/message-events"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.what[x]"
},
{
"identity" : "v2",
"map" : "MSH-9.2"
},
{
"identity" : "rim",
"map" : "./payload[classCode=\"CACT\" and moodCode=\"EVN\" and isNormalAct()]/code[isNormalDatatype()]/code"
}]
},
{
"id" : "MessageHeader.destination",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "MessageDestination"
}],
"path" : "MessageHeader.destination",
"short" : "Message destination application(s)",
"definition" : "The destination application which the message is intended for.",
"comment" : "There SHOULD be at least one destination, but in some circumstances, the source system is unaware of any particular destination system.",
"requirements" : "Indicates where message is to be sent for routing purposes. Allows verification of \"am I the intended recipient\".",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MessageHeader.destination",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.subject[x]"
},
{
"identity" : "rim",
"map" : "./communicationFunction[typeCode=\"RCV\"]"
},
{
"identity" : "w5",
"map" : "FiveWs.subject"
}]
},
{
"id" : "MessageHeader.destination.id",
"path" : "MessageHeader.destination.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MessageHeader.destination.extension",
"path" : "MessageHeader.destination.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MessageHeader.destination.modifierExtension",
"path" : "MessageHeader.destination.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MessageHeader.destination.name",
"path" : "MessageHeader.destination.name",
"short" : "Name of system",
"definition" : "Human-readable name for the target system.",
"requirements" : "May be used for routing of response and/or to support audit.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MessageHeader.destination.name",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "v2",
"map" : "MSH-5"
},
{
"identity" : "rim",
"map" : "unique(./entity[determinerCode=\"INST\" and (classCode=(\"DEV\", \"PSN\", \"ORG\"]/name[type='ST' and isNormalDatatype()])"
}]
},
{
"id" : "MessageHeader.destination.target",
"path" : "MessageHeader.destination.target",
"short" : "Particular delivery destination within the destination",
"definition" : "Identifies the target end system in situations where the initial message transmission is to an intermediary system.",
"requirements" : "Supports multi-hop routing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MessageHeader.destination.target",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Device"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "unique(./entity[determinerCode=\"INST\" and (classCode=(\"DEV\", \"PSN\", \"ORG\"]"
}]
},
{
"id" : "MessageHeader.destination.endpoint",
"path" : "MessageHeader.destination.endpoint",
"short" : "Actual destination address or id",
"definition" : "Indicates where the message should be routed to.",
"comment" : "The id may be a non-resolvable URI for systems that do not use standard network-based addresses.",
"requirements" : "Identifies where to route the message.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "MessageHeader.destination.endpoint",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "url"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "v2",
"map" : "MSH-25 (or MSH-6)"
},
{
"identity" : "rim",
"map" : "./telecom"
}]
},
{
"id" : "MessageHeader.destination.receiver",
"path" : "MessageHeader.destination.receiver",
"short" : "Intended \"real-world\" recipient for the data",
"definition" : "Allows data conveyed by a message to be addressed to a particular person or department when routing to a specific application isn't sufficient.",
"requirements" : "Allows routing beyond just the application level.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MessageHeader.destination.receiver",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.subject[x]"
},
{
"identity" : "v2",
"map" : "PRT-5:PRT-4='WAYR' / PRT-8:PRT-4='WAYR'"
},
{
"identity" : "rim",
"map" : "Not directly supported. Could be shared using attentionLine.value with an appropriate keyWordText"
},
{
"identity" : "w5",
"map" : "FiveWs.subject"
}]
},
{
"id" : "MessageHeader.sender",
"path" : "MessageHeader.sender",
"short" : "Real world sender of the message",
"definition" : "Identifies the sending system to allow the use of a trust relationship.",
"comment" : "Use case is for where a (trusted) sending system is responsible for multiple organizations, and therefore cannot differentiate based on source endpoint / authentication alone.",
"requirements" : "Allows routing beyond just the application level.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MessageHeader.sender",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.subject[x]"
},
{
"identity" : "v2",
"map" : "PRT-5:PRT-4='WAYR' / PRT-8:PRT-4='WAYR'"
},
{
"identity" : "rim",
"map" : "Not directly supported. Could be shared using attentionLine.value with an appropriate keyWordText"
},
{
"identity" : "w5",
"map" : "FiveWs.subject"
}]
},
{
"id" : "MessageHeader.enterer",
"path" : "MessageHeader.enterer",
"short" : "The source of the data entry",
"definition" : "The person or device that performed the data entry leading to this message. When there is more than one candidate, pick the most proximal to the message. Can provide other enterers in extensions.",
"comment" : "Usually only for the request but can be used in a response.",
"requirements" : "Need to know for audit/traceback requirements and possibly for authorization.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MessageHeader.enterer",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.author"
},
{
"identity" : "v2",
"map" : "EVN-5 / ORC-10 / PRT-5:PRT-4='EP' / ROL where ROL.3 is EP or ORC.10"
},
{
"identity" : "rim",
"map" : "unique(./controlAct[classCode=\"CACT\" and classCode=\"EVN\" and isNormalAct()]/participation[typeCode=\"ENT\" and isNormalParticipation]/role[classCode=\"ASSIGNED\" and isNormalRole()]/player[isNormalEntity() and classCode=(\"DEV\", \"PSN\") and determinerCode=\"INST\"])"
}]
},
{
"id" : "MessageHeader.author",
"path" : "MessageHeader.author",
"short" : "The source of the decision",
"definition" : "The logical author of the message - the person or device that decided the described event should happen. When there is more than one candidate, pick the most proximal to the MessageHeader. Can provide other authors in extensions.",
"comment" : "Usually only for the request but can be used in a response.",
"requirements" : "Need to know for audit/traceback requirements and possibly for authorization.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MessageHeader.author",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.author"
},
{
"identity" : "v2",
"map" : "ORC-19 / PRT-5:PRT-4='AUT' / ROL where ROL.3 is IP or ORC.12"
},
{
"identity" : "rim",
"map" : "unique(./controlAct[classCode=\"CACT\" and classCode=\"EVN\" and isNormalAct()]/participation[isHighest(priorityCode) and typeCode=\"AUT\" and isNormalParticipation]/role[classCode=\"ASSIGNED\" and isNormalRole()]/player[isNormalEntity() and classCode=(\"DEV\", \"PSN\") and determinerCode=\"INST\"])"
}]
},
{
"id" : "MessageHeader.source",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "MessageSource"
}],
"path" : "MessageHeader.source",
"short" : "Message source application",
"definition" : "The source application from which this message originated.",
"requirements" : "Allows replies, supports audit.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "MessageHeader.source",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.actor"
},
{
"identity" : "rim",
"map" : "unique(./communicationFunction[typeCode=\"SND\"])"
}]
},
{
"id" : "MessageHeader.source.id",
"path" : "MessageHeader.source.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MessageHeader.source.extension",
"path" : "MessageHeader.source.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MessageHeader.source.modifierExtension",
"path" : "MessageHeader.source.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MessageHeader.source.name",
"path" : "MessageHeader.source.name",
"short" : "Name of system",
"definition" : "Human-readable name for the source system.",
"requirements" : "May be used to support audit.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MessageHeader.source.name",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "v2",
"map" : "MSH-3"
},
{
"identity" : "rim",
"map" : "unique(./entity[determinerCode=\"INST\" and classCode=\"DEV\"]/name[type='ST' and isNormalDatatype()])"
}]
},
{
"id" : "MessageHeader.source.software",
"path" : "MessageHeader.source.software",
"short" : "Name of software running the system",
"definition" : "May include configuration or other information useful in debugging.",
"requirements" : "Supports audit and possibly interface engine behavior.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MessageHeader.source.software",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "v2",
"map" : "SFT-3 ( +SFT-1)"
},
{
"identity" : "rim",
"map" : "unique(./entity[determinerCode=\"INST\" and classCode=\"DEV\"]/softwareName[isNormalDatatype()])"
}]
},
{
"id" : "MessageHeader.source.version",
"path" : "MessageHeader.source.version",
"short" : "Version of software running",
"definition" : "Can convey versions of multiple systems in situations where a message passes through multiple hands.",
"requirements" : "Supports audit and possibly interface engine behavior.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MessageHeader.source.version",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "v2",
"map" : "SFT-2"
},
{
"identity" : "rim",
"map" : "(Not supported)"
}]
},
{
"id" : "MessageHeader.source.contact",
"path" : "MessageHeader.source.contact",
"short" : "Human contact for problems",
"definition" : "An e-mail, phone, website or other contact point to use to resolve issues with message communications.",
"requirements" : "Allows escalation of technical issues.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MessageHeader.source.contact",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "ContactPoint"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "v2",
"map" : "(MSH-22?)"
},
{
"identity" : "rim",
"map" : "unique(./entity[determinerCode=\"INST\" and classCode=\"DEV\"]/scopesRole[normalRole() and classCode=\"CON\" and layer[classCode=\"PSN\"]/telecom[isNormalDatatype()])"
}]
},
{
"id" : "MessageHeader.source.endpoint",
"path" : "MessageHeader.source.endpoint",
"short" : "Actual message source address or id",
"definition" : "Identifies the routing target to send acknowledgements to.",
"comment" : "The id may be a non-resolvable URI for systems that do not use standard network-based addresses.",
"requirements" : "Identifies where to send responses, may influence security permissions.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "MessageHeader.source.endpoint",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "url"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "v2",
"map" : "MSH-24"
},
{
"identity" : "rim",
"map" : "./telecom[isNormalDatatype()]"
}]
},
{
"id" : "MessageHeader.responsible",
"path" : "MessageHeader.responsible",
"short" : "Final responsibility for event",
"definition" : "The person or organization that accepts overall responsibility for the contents of the message. The implication is that the message event happened under the policies of the responsible party.",
"comment" : "Usually only for the request but can be used in a response.",
"requirements" : "Need to know for audit/traceback requirements and possibly for authorization.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MessageHeader.responsible",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.witness"
},
{
"identity" : "v2",
"map" : "ORC-12 / PRT-5:PRT-4='OP' / PRT-8:PRT-4='OP' / ROL where ROL.3 is RO or ORC.11"
},
{
"identity" : "rim",
"map" : "unique(./controlAct[classCode=\"CACT\" and classCode=\"EVN\" and isNormalAct()]/participation[isHighest(priorityCode) and typeCode=\"RESP\" and isNormalParticipation]/role[classCode=\"ASSIGNED\" and isNormalRole()]/player[isNormalEntity() and classCode=\"PSN\" and determinerCode=\"INST\"] or ./controlAct[classCode=\"CACT\" and classCode=\"EVN\" and isNormalAct()]/participation[isHighest(priorityCode) and typeCode=\"RESP\" and isNormalParticipation]/role[classCode=\"ASSIGNED\" and isNormalRole()]/scoper[isNormalEntity() and classCode=\"ORG\" and determinerCode=\"INST\"])"
}]
},
{
"id" : "MessageHeader.reason",
"path" : "MessageHeader.reason",
"short" : "Cause of event",
"definition" : "Coded indication of the cause for the event - indicates a reason for the occurrence of the event that is a focus of this message.",
"requirements" : "Need to be able to track why resources are being changed and report in the audit log/history of the resource. May affect authorization.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MessageHeader.reason",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "EventReason"
}],
"strength" : "example",
"description" : "Reason for event occurrence.",
"valueSet" : "http://hl7.org/fhir/ValueSet/message-reason-encounter"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "v2",
"map" : "EVN.4 / ORC.16 / OBR-31-reason for study / BPO-13-BP indication for use / RXO-20-indication / RXE-27-give indication / RXD-21-indication / RXG-22-indication / RXA-19-indication"
},
{
"identity" : "rim",
"map" : "unique(./controlAct[classCode=\"CACT\" and classCode=\"EVN\" and isNormalAct()]/reasonCode[isNormalDatatype()])"
}]
},
{
"id" : "MessageHeader.response",
"path" : "MessageHeader.response",
"short" : "If this is a reply to prior message",
"definition" : "Information about the message that this message is a response to. Only present if this message is a response.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MessageHeader.response",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "v2",
"map" : "MSA"
},
{
"identity" : "rim",
"map" : "./conveyedAcknowledgement"
}]
},
{
"id" : "MessageHeader.response.id",
"path" : "MessageHeader.response.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MessageHeader.response.extension",
"path" : "MessageHeader.response.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MessageHeader.response.modifierExtension",
"path" : "MessageHeader.response.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MessageHeader.response.identifier",
"path" : "MessageHeader.response.identifier",
"short" : "Id of original message",
"definition" : "The MessageHeader.id of the message to which this message is a response.",
"requirements" : "Allows receiver to know what message is being responded to.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "MessageHeader.response.identifier",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "id"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "v2",
"map" : "MSA-2"
},
{
"identity" : "rim",
"map" : "./acknowledges.id[isNormalDatatype()]"
}]
},
{
"id" : "MessageHeader.response.code",
"path" : "MessageHeader.response.code",
"short" : "ok | transient-error | fatal-error",
"definition" : "Code that identifies the type of response to the message - whether it was successful or not, and whether it should be resent or not.",
"comment" : "This is a generic response to the request message. Specific data for the response will be found in MessageHeader.focus.",
"requirements" : "Allows the sender of the acknowledge message to know if the request was successful or if action is needed.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "MessageHeader.response.code",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ResponseType"
}],
"strength" : "required",
"description" : "The kind of response to a message.",
"valueSet" : "http://hl7.org/fhir/ValueSet/response-code|4.0.1"
},
"mapping" : [{
"identity" : "v2",
"map" : "MSA-1"
},
{
"identity" : "rim",
"map" : "./typeCode[isNormalDatatype()]"
}]
},
{
"id" : "MessageHeader.response.details",
"path" : "MessageHeader.response.details",
"short" : "Specific list of hints/warnings/errors",
"definition" : "Full details of any issues found in the message.",
"comment" : "This SHALL be contained in the bundle. If any of the issues are errors, the response code SHALL be an error.",
"requirements" : "Allows the sender of the message to determine what the specific issues are.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MessageHeader.response.details",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/OperationOutcome"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "v2",
"map" : "ERR"
},
{
"identity" : "rim",
"map" : "AcknowledgementDetail or Observation[classCode=\"ALRT\" and moodCode=\"EVN\"]"
}]
},
{
"id" : "MessageHeader.focus",
"path" : "MessageHeader.focus",
"short" : "The actual content of the message",
"definition" : "The actual data of the message - a reference to the root/focus class of the event.",
"comment" : "The data is defined where the transaction type is defined. The transaction data is always included in the bundle that is the full message. Only the root resource is specified. The resources it references should be contained in the bundle but are not also listed here. Multiple repetitions are allowed to cater for merges and other situations with multiple focal targets.",
"requirements" : "Every message event is about actual data, a single resource, that is identified in the definition of the event, and perhaps some or all linked resources.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MessageHeader.focus",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "unique(./controlAct[classCode=\"CACT\" and classCode=\"EVN\" and isNormalAct()]/participation[typeCode=\"SUBJ\" and isNormalParticipation]/role or ./controlAct[classCode=\"CACT\" and classCode=\"EVN\" and isNormalAct()]/outboundRelationship[typeCode=\"SBJ\" and isNormalActRelatoinship]/target)"
}]
},
{
"id" : "MessageHeader.definition",
"path" : "MessageHeader.definition",
"short" : "Link to the definition for this message",
"definition" : "Permanent link to the MessageDefinition for this message.",
"requirements" : "Allows sender to define the expected contents of the message.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MessageHeader.definition",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/MessageDefinition"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "Not directly supported."
}]
}]
},
"differential" : {
"element" : [{
"id" : "MessageHeader",
"path" : "MessageHeader",
"short" : "A resource that describes a message that is exchanged between systems",
"definition" : "The header for a message exchange that is either requesting or responding to an action. The reference(s) that are the subject of the action as well as other information related to the action are typically transmitted in a bundle in which the MessageHeader resource instance is the first resource in the bundle.",
"min" : 0,
"max" : "*",
"mapping" : [{
"identity" : "v2",
"map" : "MSH / MSA / ERR"
},
{
"identity" : "rim",
"map" : "Message"
}]
},
{
"id" : "MessageHeader.event[x]",
"path" : "MessageHeader.event[x]",
"short" : "Code for the event this message represents or link to event definition",
"definition" : "Code that identifies the event this message represents and connects it with its definition. Events defined as part of the FHIR specification have the system value \"http://terminology.hl7.org/CodeSystem/message-events\". Alternatively uri to the EventDefinition.",
"comment" : "The time of the event will be found in the focus resource. The time of the message will be found in [Bundle.timestamp](bundle-definitions.html#Bundle.timestamp).",
"requirements" : "Drives the behavior associated with this message.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "Coding"
},
{
"code" : "uri"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MessageEvent"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "example",
"description" : "One of the message events defined as part of this version of FHIR.",
"valueSet" : "http://hl7.org/fhir/ValueSet/message-events"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.what[x]"
},
{
"identity" : "v2",
"map" : "MSH-9.2"
},
{
"identity" : "rim",
"map" : "./payload[classCode=\"CACT\" and moodCode=\"EVN\" and isNormalAct()]/code[isNormalDatatype()]/code"
}]
},
{
"id" : "MessageHeader.destination",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "MessageDestination"
}],
"path" : "MessageHeader.destination",
"short" : "Message destination application(s)",
"definition" : "The destination application which the message is intended for.",
"comment" : "There SHOULD be at least one destination, but in some circumstances, the source system is unaware of any particular destination system.",
"requirements" : "Indicates where message is to be sent for routing purposes. Allows verification of \"am I the intended recipient\".",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.subject[x]"
},
{
"identity" : "rim",
"map" : "./communicationFunction[typeCode=\"RCV\"]"
},
{
"identity" : "w5",
"map" : "FiveWs.subject"
}]
},
{
"id" : "MessageHeader.destination.name",
"path" : "MessageHeader.destination.name",
"short" : "Name of system",
"definition" : "Human-readable name for the target system.",
"requirements" : "May be used for routing of response and/or to support audit.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "v2",
"map" : "MSH-5"
},
{
"identity" : "rim",
"map" : "unique(./entity[determinerCode=\"INST\" and (classCode=(\"DEV\", \"PSN\", \"ORG\"]/name[type='ST' and isNormalDatatype()])"
}]
},
{
"id" : "MessageHeader.destination.target",
"path" : "MessageHeader.destination.target",
"short" : "Particular delivery destination within the destination",
"definition" : "Identifies the target end system in situations where the initial message transmission is to an intermediary system.",
"requirements" : "Supports multi-hop routing.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Device"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "unique(./entity[determinerCode=\"INST\" and (classCode=(\"DEV\", \"PSN\", \"ORG\"]"
}]
},
{
"id" : "MessageHeader.destination.endpoint",
"path" : "MessageHeader.destination.endpoint",
"short" : "Actual destination address or id",
"definition" : "Indicates where the message should be routed to.",
"comment" : "The id may be a non-resolvable URI for systems that do not use standard network-based addresses.",
"requirements" : "Identifies where to route the message.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "url"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "v2",
"map" : "MSH-25 (or MSH-6)"
},
{
"identity" : "rim",
"map" : "./telecom"
}]
},
{
"id" : "MessageHeader.destination.receiver",
"path" : "MessageHeader.destination.receiver",
"short" : "Intended \"real-world\" recipient for the data",
"definition" : "Allows data conveyed by a message to be addressed to a particular person or department when routing to a specific application isn't sufficient.",
"requirements" : "Allows routing beyond just the application level.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.subject[x]"
},
{
"identity" : "v2",
"map" : "PRT-5:PRT-4='WAYR' / PRT-8:PRT-4='WAYR'"
},
{
"identity" : "rim",
"map" : "Not directly supported. Could be shared using attentionLine.value with an appropriate keyWordText"
},
{
"identity" : "w5",
"map" : "FiveWs.subject"
}]
},
{
"id" : "MessageHeader.sender",
"path" : "MessageHeader.sender",
"short" : "Real world sender of the message",
"definition" : "Identifies the sending system to allow the use of a trust relationship.",
"comment" : "Use case is for where a (trusted) sending system is responsible for multiple organizations, and therefore cannot differentiate based on source endpoint / authentication alone.",
"requirements" : "Allows routing beyond just the application level.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.subject[x]"
},
{
"identity" : "v2",
"map" : "PRT-5:PRT-4='WAYR' / PRT-8:PRT-4='WAYR'"
},
{
"identity" : "rim",
"map" : "Not directly supported. Could be shared using attentionLine.value with an appropriate keyWordText"
},
{
"identity" : "w5",
"map" : "FiveWs.subject"
}]
},
{
"id" : "MessageHeader.enterer",
"path" : "MessageHeader.enterer",
"short" : "The source of the data entry",
"definition" : "The person or device that performed the data entry leading to this message. When there is more than one candidate, pick the most proximal to the message. Can provide other enterers in extensions.",
"comment" : "Usually only for the request but can be used in a response.",
"requirements" : "Need to know for audit/traceback requirements and possibly for authorization.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.author"
},
{
"identity" : "v2",
"map" : "EVN-5 / ORC-10 / PRT-5:PRT-4='EP' / ROL where ROL.3 is EP or ORC.10"
},
{
"identity" : "rim",
"map" : "unique(./controlAct[classCode=\"CACT\" and classCode=\"EVN\" and isNormalAct()]/participation[typeCode=\"ENT\" and isNormalParticipation]/role[classCode=\"ASSIGNED\" and isNormalRole()]/player[isNormalEntity() and classCode=(\"DEV\", \"PSN\") and determinerCode=\"INST\"])"
}]
},
{
"id" : "MessageHeader.author",
"path" : "MessageHeader.author",
"short" : "The source of the decision",
"definition" : "The logical author of the message - the person or device that decided the described event should happen. When there is more than one candidate, pick the most proximal to the MessageHeader. Can provide other authors in extensions.",
"comment" : "Usually only for the request but can be used in a response.",
"requirements" : "Need to know for audit/traceback requirements and possibly for authorization.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.author"
},
{
"identity" : "v2",
"map" : "ORC-19 / PRT-5:PRT-4='AUT' / ROL where ROL.3 is IP or ORC.12"
},
{
"identity" : "rim",
"map" : "unique(./controlAct[classCode=\"CACT\" and classCode=\"EVN\" and isNormalAct()]/participation[isHighest(priorityCode) and typeCode=\"AUT\" and isNormalParticipation]/role[classCode=\"ASSIGNED\" and isNormalRole()]/player[isNormalEntity() and classCode=(\"DEV\", \"PSN\") and determinerCode=\"INST\"])"
}]
},
{
"id" : "MessageHeader.source",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "MessageSource"
}],
"path" : "MessageHeader.source",
"short" : "Message source application",
"definition" : "The source application from which this message originated.",
"requirements" : "Allows replies, supports audit.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "BackboneElement"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.actor"
},
{
"identity" : "rim",
"map" : "unique(./communicationFunction[typeCode=\"SND\"])"
}]
},
{
"id" : "MessageHeader.source.name",
"path" : "MessageHeader.source.name",
"short" : "Name of system",
"definition" : "Human-readable name for the source system.",
"requirements" : "May be used to support audit.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "v2",
"map" : "MSH-3"
},
{
"identity" : "rim",
"map" : "unique(./entity[determinerCode=\"INST\" and classCode=\"DEV\"]/name[type='ST' and isNormalDatatype()])"
}]
},
{
"id" : "MessageHeader.source.software",
"path" : "MessageHeader.source.software",
"short" : "Name of software running the system",
"definition" : "May include configuration or other information useful in debugging.",
"requirements" : "Supports audit and possibly interface engine behavior.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "v2",
"map" : "SFT-3 ( +SFT-1)"
},
{
"identity" : "rim",
"map" : "unique(./entity[determinerCode=\"INST\" and classCode=\"DEV\"]/softwareName[isNormalDatatype()])"
}]
},
{
"id" : "MessageHeader.source.version",
"path" : "MessageHeader.source.version",
"short" : "Version of software running",
"definition" : "Can convey versions of multiple systems in situations where a message passes through multiple hands.",
"requirements" : "Supports audit and possibly interface engine behavior.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "v2",
"map" : "SFT-2"
},
{
"identity" : "rim",
"map" : "(Not supported)"
}]
},
{
"id" : "MessageHeader.source.contact",
"path" : "MessageHeader.source.contact",
"short" : "Human contact for problems",
"definition" : "An e-mail, phone, website or other contact point to use to resolve issues with message communications.",
"requirements" : "Allows escalation of technical issues.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "ContactPoint"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "v2",
"map" : "(MSH-22?)"
},
{
"identity" : "rim",
"map" : "unique(./entity[determinerCode=\"INST\" and classCode=\"DEV\"]/scopesRole[normalRole() and classCode=\"CON\" and layer[classCode=\"PSN\"]/telecom[isNormalDatatype()])"
}]
},
{
"id" : "MessageHeader.source.endpoint",
"path" : "MessageHeader.source.endpoint",
"short" : "Actual message source address or id",
"definition" : "Identifies the routing target to send acknowledgements to.",
"comment" : "The id may be a non-resolvable URI for systems that do not use standard network-based addresses.",
"requirements" : "Identifies where to send responses, may influence security permissions.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "url"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "v2",
"map" : "MSH-24"
},
{
"identity" : "rim",
"map" : "./telecom[isNormalDatatype()]"
}]
},
{
"id" : "MessageHeader.responsible",
"path" : "MessageHeader.responsible",
"short" : "Final responsibility for event",
"definition" : "The person or organization that accepts overall responsibility for the contents of the message. The implication is that the message event happened under the policies of the responsible party.",
"comment" : "Usually only for the request but can be used in a response.",
"requirements" : "Need to know for audit/traceback requirements and possibly for authorization.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.witness"
},
{
"identity" : "v2",
"map" : "ORC-12 / PRT-5:PRT-4='OP' / PRT-8:PRT-4='OP' / ROL where ROL.3 is RO or ORC.11"
},
{
"identity" : "rim",
"map" : "unique(./controlAct[classCode=\"CACT\" and classCode=\"EVN\" and isNormalAct()]/participation[isHighest(priorityCode) and typeCode=\"RESP\" and isNormalParticipation]/role[classCode=\"ASSIGNED\" and isNormalRole()]/player[isNormalEntity() and classCode=\"PSN\" and determinerCode=\"INST\"] or ./controlAct[classCode=\"CACT\" and classCode=\"EVN\" and isNormalAct()]/participation[isHighest(priorityCode) and typeCode=\"RESP\" and isNormalParticipation]/role[classCode=\"ASSIGNED\" and isNormalRole()]/scoper[isNormalEntity() and classCode=\"ORG\" and determinerCode=\"INST\"])"
}]
},
{
"id" : "MessageHeader.reason",
"path" : "MessageHeader.reason",
"short" : "Cause of event",
"definition" : "Coded indication of the cause for the event - indicates a reason for the occurrence of the event that is a focus of this message.",
"requirements" : "Need to be able to track why resources are being changed and report in the audit log/history of the resource. May affect authorization.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "EventReason"
}],
"strength" : "example",
"description" : "Reason for event occurrence.",
"valueSet" : "http://hl7.org/fhir/ValueSet/message-reason-encounter"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "v2",
"map" : "EVN.4 / ORC.16 / OBR-31-reason for study / BPO-13-BP indication for use / RXO-20-indication / RXE-27-give indication / RXD-21-indication / RXG-22-indication / RXA-19-indication"
},
{
"identity" : "rim",
"map" : "unique(./controlAct[classCode=\"CACT\" and classCode=\"EVN\" and isNormalAct()]/reasonCode[isNormalDatatype()])"
}]
},
{
"id" : "MessageHeader.response",
"path" : "MessageHeader.response",
"short" : "If this is a reply to prior message",
"definition" : "Information about the message that this message is a response to. Only present if this message is a response.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "BackboneElement"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "v2",
"map" : "MSA"
},
{
"identity" : "rim",
"map" : "./conveyedAcknowledgement"
}]
},
{
"id" : "MessageHeader.response.identifier",
"path" : "MessageHeader.response.identifier",
"short" : "Id of original message",
"definition" : "The MessageHeader.id of the message to which this message is a response.",
"requirements" : "Allows receiver to know what message is being responded to.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "id"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "v2",
"map" : "MSA-2"
},
{
"identity" : "rim",
"map" : "./acknowledges.id[isNormalDatatype()]"
}]
},
{
"id" : "MessageHeader.response.code",
"path" : "MessageHeader.response.code",
"short" : "ok | transient-error | fatal-error",
"definition" : "Code that identifies the type of response to the message - whether it was successful or not, and whether it should be resent or not.",
"comment" : "This is a generic response to the request message. Specific data for the response will be found in MessageHeader.focus.",
"requirements" : "Allows the sender of the acknowledge message to know if the request was successful or if action is needed.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ResponseType"
}],
"strength" : "required",
"description" : "The kind of response to a message.",
"valueSet" : "http://hl7.org/fhir/ValueSet/response-code|4.0.1"
},
"mapping" : [{
"identity" : "v2",
"map" : "MSA-1"
},
{
"identity" : "rim",
"map" : "./typeCode[isNormalDatatype()]"
}]
},
{
"id" : "MessageHeader.response.details",
"path" : "MessageHeader.response.details",
"short" : "Specific list of hints/warnings/errors",
"definition" : "Full details of any issues found in the message.",
"comment" : "This SHALL be contained in the bundle. If any of the issues are errors, the response code SHALL be an error.",
"requirements" : "Allows the sender of the message to determine what the specific issues are.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/OperationOutcome"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "v2",
"map" : "ERR"
},
{
"identity" : "rim",
"map" : "AcknowledgementDetail or Observation[classCode=\"ALRT\" and moodCode=\"EVN\"]"
}]
},
{
"id" : "MessageHeader.focus",
"path" : "MessageHeader.focus",
"short" : "The actual content of the message",
"definition" : "The actual data of the message - a reference to the root/focus class of the event.",
"comment" : "The data is defined where the transaction type is defined. The transaction data is always included in the bundle that is the full message. Only the root resource is specified. The resources it references should be contained in the bundle but are not also listed here. Multiple repetitions are allowed to cater for merges and other situations with multiple focal targets.",
"requirements" : "Every message event is about actual data, a single resource, that is identified in the definition of the event, and perhaps some or all linked resources.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "unique(./controlAct[classCode=\"CACT\" and classCode=\"EVN\" and isNormalAct()]/participation[typeCode=\"SUBJ\" and isNormalParticipation]/role or ./controlAct[classCode=\"CACT\" and classCode=\"EVN\" and isNormalAct()]/outboundRelationship[typeCode=\"SBJ\" and isNormalActRelatoinship]/target)"
}]
},
{
"id" : "MessageHeader.definition",
"path" : "MessageHeader.definition",
"short" : "Link to the definition for this message",
"definition" : "Permanent link to the MessageDefinition for this message.",
"requirements" : "Allows sender to define the expected contents of the message.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/MessageDefinition"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "Not directly supported."
}]
}]
}
}
},
{
"fullUrl" : "http://hl7.org/fhir/StructureDefinition/MolecularSequence",
"resource" : {
"resourceType" : "StructureDefinition",
"id" : "MolecularSequence",
"meta" : {
"lastUpdated" : "2019-11-01T09:29:23.356+11:00"
},
"text" : {
"status" : "generated",
"div" : "Name Flags Card. Type Description & Constraints MolecularSequence ΣITU DomainResource Information about a biological sequence
+ Rule: Only 0 and 1 are valid for coordinateSystem
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension identifier Σ 0..* Identifier Unique ID for this particular sequence. This is a FHIR-defined id
type Σ 0..1 code aa | dna | rna
sequenceType (Required) coordinateSystem Σ 1..1 integer Base number of coordinate system (0 for 0-based numbering or coordinates, inclusive start, exclusive end, 1 for 1-based numbering, inclusive start, inclusive end) patient Σ 0..1 Reference(Patient) Who and/or what this is about specimen Σ 0..1 Reference(Specimen) Specimen used for sequencing device Σ 0..1 Reference(Device) The method for sequencing performer Σ 0..1 Reference(Organization) Who should be responsible for test result quantity Σ 0..1 Quantity The number of copies of the sequence of interest. (RNASeq) referenceSeq ΣI 0..1 BackboneElement A sequence used as reference
+ Rule: GenomeBuild and chromosome must be both contained if either one of them is contained
+ Rule: Have and only have one of the following elements in referenceSeq : 1. genomeBuild ; 2 referenceSeqId; 3. referenceSeqPointer; 4. referenceSeqString; chromosome Σ 0..1 CodeableConcept Chromosome containing genetic finding
chromosome-human (Example) genomeBuild Σ 0..1 string The Genome Build used for reference, following GRCh build versions e.g. 'GRCh 37' orientation Σ 0..1 code sense | antisense
orientationType (Required) referenceSeqId Σ 0..1 CodeableConcept Reference identifier
E n s e m b l (Example) referenceSeqPointer Σ 0..1 Reference(MolecularSequence) A pointer to another MolecularSequence entity as reference sequence referenceSeqString Σ 0..1 string A string to represent reference sequence strand Σ 0..1 code watson | crick
strandType (Required) windowStart Σ 0..1 integer Start position of the window on the reference sequence windowEnd Σ 0..1 integer End position of the window on the reference sequence variant Σ 0..* BackboneElement Variant in sequence
start Σ 0..1 integer Start position of the variant on the reference sequence end Σ 0..1 integer End position of the variant on the reference sequence observedAllele Σ 0..1 string Allele that was observed referenceAllele Σ 0..1 string Allele in the reference sequence cigar Σ 0..1 string Extended CIGAR string for aligning the sequence with reference bases variantPointer Σ 0..1 Reference(Observation) Pointer to observed variant information observedSeq Σ 0..1 string Sequence that was observed quality Σ 0..* BackboneElement An set of value as quality of sequence
type Σ 1..1 code indel | snp | unknown
qualityType (Required) standardSequence Σ 0..1 CodeableConcept Standard sequence for comparison
F d a- standard sequence (Example) start Σ 0..1 integer Start position of the sequence end Σ 0..1 integer End position of the sequence score Σ 0..1 Quantity Quality score for the comparison method Σ 0..1 CodeableConcept Method to get quality
F d a- method (Example) truthTP Σ 0..1 decimal True positives from the perspective of the truth data queryTP Σ 0..1 decimal True positives from the perspective of the query data truthFN Σ 0..1 decimal False negatives queryFP Σ 0..1 decimal False positives gtFP Σ 0..1 decimal False positives where the non-REF alleles in the Truth and Query Call Sets match precision Σ 0..1 decimal Precision of comparison recall Σ 0..1 decimal Recall of comparison fScore Σ 0..1 decimal F-score roc Σ 0..1 BackboneElement Receiver Operator Characteristic (ROC) Curve score Σ 0..* integer Genotype quality score
numTP Σ 0..* integer Roc score true positive numbers
numFP Σ 0..* integer Roc score false positive numbers
numFN Σ 0..* integer Roc score false negative numbers
precision Σ 0..* decimal Precision of the GQ score
sensitivity Σ 0..* decimal Sensitivity of the GQ score
fMeasure Σ 0..* decimal FScore of the GQ score
readCoverage Σ 0..1 integer Average number of reads representing a given nucleotide in the reconstructed sequence repository Σ 0..* BackboneElement External repository which contains detailed report related with observedSeq in this resource
type Σ 1..1 code directlink | openapi | login | oauth | other
repositoryType (Required) url Σ 0..1 uri URI of the repository name Σ 0..1 string Repository's name datasetId Σ 0..1 string Id of the dataset that used to call for dataset in repository variantsetId Σ 0..1 string Id of the variantset that used to call for variantset in repository readsetId Σ 0..1 string Id of the read pointer Σ 0..* Reference(MolecularSequence) Pointer to next atomic sequence
structureVariant Σ 0..* BackboneElement Structural variant
variantType Σ 0..1 CodeableConcept Structural variant change type
LOINC LL379-9 answerlist (Required) exact Σ 0..1 boolean Does the structural variant have base pair resolution breakpoints? length Σ 0..1 integer Structural variant length outer Σ 0..1 BackboneElement Structural variant outer start Σ 0..1 integer Structural variant outer start end Σ 0..1 integer Structural variant outer end inner Σ 0..1 BackboneElement Structural variant inner start Σ 0..1 integer Structural variant inner start end Σ 0..1 integer Structural variant inner end
Documentation for this format
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Clinical.Diagnostics"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 1
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "patient"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "cg"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/MolecularSequence",
"version" : "4.0.1",
"name" : "MolecularSequence",
"status" : "draft",
"date" : "2019-11-01T09:29:23+11:00",
"publisher" : "Health Level Seven International (Clinical Genomics)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/clingenomics/index.cfm"
}]
}],
"description" : "Raw data describing a biological sequence.",
"fhirVersion" : "4.0.1",
"mapping" : [{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/fivews",
"name" : "FiveWs Pattern Mapping"
},
{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
}],
"kind" : "resource",
"abstract" : false,
"type" : "MolecularSequence",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "MolecularSequence",
"path" : "MolecularSequence",
"short" : "Information about a biological sequence",
"definition" : "Raw data describing a biological sequence.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MolecularSequence",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "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",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.`div`.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "msq-3",
"severity" : "error",
"human" : "Only 0 and 1 are valid for coordinateSystem",
"expression" : "coordinateSystem = 1 or coordinateSystem = 0",
"xpath" : "count(f:coordinateSystem[@value=0 and @value=1]) = 1"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
}]
},
{
"id" : "MolecularSequence.id",
"path" : "MolecularSequence.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MolecularSequence.meta",
"path" : "MolecularSequence.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MolecularSequence.implicitRules",
"path" : "MolecularSequence.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "MolecularSequence.language",
"path" : "MolecularSequence.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "MolecularSequence.text",
"path" : "MolecularSequence.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "MolecularSequence.contained",
"path" : "MolecularSequence.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MolecularSequence.extension",
"path" : "MolecularSequence.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MolecularSequence.modifierExtension",
"path" : "MolecularSequence.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MolecularSequence.identifier",
"path" : "MolecularSequence.identifier",
"short" : "Unique ID for this particular sequence. This is a FHIR-defined id",
"definition" : "A unique identifier for this particular sequence instance. This is a FHIR-defined id.",
"requirements" : "Allows sequences to be distinguished and referenced.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MolecularSequence.identifier",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Identifier"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.identifier"
}]
},
{
"id" : "MolecularSequence.type",
"path" : "MolecularSequence.type",
"short" : "aa | dna | rna",
"definition" : "Amino Acid Sequence/ DNA Sequence / RNA Sequence.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MolecularSequence.type",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "sequenceType"
}],
"strength" : "required",
"description" : "Type if a sequence -- DNA, RNA, or amino acid sequence.",
"valueSet" : "http://hl7.org/fhir/ValueSet/sequence-type|4.0.1"
}
},
{
"id" : "MolecularSequence.coordinateSystem",
"path" : "MolecularSequence.coordinateSystem",
"short" : "Base number of coordinate system (0 for 0-based numbering or coordinates, inclusive start, exclusive end, 1 for 1-based numbering, inclusive start, inclusive end)",
"definition" : "Whether the sequence is numbered starting at 0 (0-based numbering or coordinates, inclusive start, exclusive end) or starting at 1 (1-based numbering, inclusive start and inclusive end).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "MolecularSequence.coordinateSystem",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "integer"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MolecularSequence.patient",
"path" : "MolecularSequence.patient",
"short" : "Who and/or what this is about",
"definition" : "The patient whose sequencing results are described by this resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MolecularSequence.patient",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MolecularSequence.specimen",
"path" : "MolecularSequence.specimen",
"short" : "Specimen used for sequencing",
"definition" : "Specimen used for sequencing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MolecularSequence.specimen",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Specimen"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MolecularSequence.device",
"path" : "MolecularSequence.device",
"short" : "The method for sequencing",
"definition" : "The method for sequencing, for example, chip information.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MolecularSequence.device",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Device"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MolecularSequence.performer",
"path" : "MolecularSequence.performer",
"short" : "Who should be responsible for test result",
"definition" : "The organization or lab that should be responsible for this result.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MolecularSequence.performer",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MolecularSequence.quantity",
"path" : "MolecularSequence.quantity",
"short" : "The number of copies of the sequence of interest. (RNASeq)",
"definition" : "The number of copies of the sequence of interest. (RNASeq).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MolecularSequence.quantity",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Quantity"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MolecularSequence.referenceSeq",
"path" : "MolecularSequence.referenceSeq",
"short" : "A sequence used as reference",
"definition" : "A sequence that is used as a reference to describe variants that are present in a sequence analyzed.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MolecularSequence.referenceSeq",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "msq-5",
"severity" : "error",
"human" : "GenomeBuild and chromosome must be both contained if either one of them is contained",
"expression" : "(chromosome.empty() and genomeBuild.empty()) or (chromosome.exists() and genomeBuild.exists())",
"xpath" : "(exists(f:chromosome) and exists(f:genomeBuild)) or (not(exists(f:chromosome)) and not(exists(f:genomeBuild)))"
},
{
"key" : "msq-6",
"severity" : "error",
"human" : "Have and only have one of the following elements in referenceSeq : 1. genomeBuild ; 2 referenceSeqId; 3. referenceSeqPointer; 4. referenceSeqString;",
"expression" : "(genomeBuild.count()+referenceSeqId.count()+ referenceSeqPointer.count()+ referenceSeqString.count()) = 1",
"xpath" : "count(f:genomeBuild)+count(f:referenceSeqId)+count(f:referenceSeqPointer)+count(f:referenceSeqString)=1"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MolecularSequence.referenceSeq.id",
"path" : "MolecularSequence.referenceSeq.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MolecularSequence.referenceSeq.extension",
"path" : "MolecularSequence.referenceSeq.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MolecularSequence.referenceSeq.modifierExtension",
"path" : "MolecularSequence.referenceSeq.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MolecularSequence.referenceSeq.chromosome",
"path" : "MolecularSequence.referenceSeq.chromosome",
"short" : "Chromosome containing genetic finding",
"definition" : "Structural unit composed of a nucleic acid molecule which controls its own replication through the interaction of specific proteins at one or more origins of replication ([SO:0000340](http://www.sequenceontology.org/browser/current_svn/term/SO:0000340)).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MolecularSequence.referenceSeq.chromosome",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "chromosome-human"
}],
"strength" : "example",
"description" : "Chromosome number for human.",
"valueSet" : "http://hl7.org/fhir/ValueSet/chromosome-human"
}
},
{
"id" : "MolecularSequence.referenceSeq.genomeBuild",
"path" : "MolecularSequence.referenceSeq.genomeBuild",
"short" : "The Genome Build used for reference, following GRCh build versions e.g. 'GRCh 37'",
"definition" : "The Genome Build used for reference, following GRCh build versions e.g. 'GRCh 37'. Version number must be included if a versioned release of a primary build was used.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MolecularSequence.referenceSeq.genomeBuild",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MolecularSequence.referenceSeq.orientation",
"path" : "MolecularSequence.referenceSeq.orientation",
"short" : "sense | antisense",
"definition" : "A relative reference to a DNA strand based on gene orientation. The strand that contains the open reading frame of the gene is the \"sense\" strand, and the opposite complementary strand is the \"antisense\" strand.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MolecularSequence.referenceSeq.orientation",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "orientationType"
}],
"strength" : "required",
"description" : "Type for orientation.",
"valueSet" : "http://hl7.org/fhir/ValueSet/orientation-type|4.0.1"
}
},
{
"id" : "MolecularSequence.referenceSeq.referenceSeqId",
"path" : "MolecularSequence.referenceSeq.referenceSeqId",
"short" : "Reference identifier",
"definition" : "Reference identifier of reference sequence submitted to NCBI. It must match the type in the MolecularSequence.type field. For example, the prefix, “NG_” identifies reference sequence for genes, “NM_” for messenger RNA transcripts, and “NP_” for amino acid sequences.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MolecularSequence.referenceSeq.referenceSeqId",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "sequenceReference"
}],
"strength" : "example",
"description" : "Reference identifier.",
"valueSet" : "http://hl7.org/fhir/ValueSet/sequence-referenceSeq"
}
},
{
"id" : "MolecularSequence.referenceSeq.referenceSeqPointer",
"path" : "MolecularSequence.referenceSeq.referenceSeqPointer",
"short" : "A pointer to another MolecularSequence entity as reference sequence",
"definition" : "A pointer to another MolecularSequence entity as reference sequence.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MolecularSequence.referenceSeq.referenceSeqPointer",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/MolecularSequence"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MolecularSequence.referenceSeq.referenceSeqString",
"path" : "MolecularSequence.referenceSeq.referenceSeqString",
"short" : "A string to represent reference sequence",
"definition" : "A string like \"ACGT\".",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MolecularSequence.referenceSeq.referenceSeqString",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MolecularSequence.referenceSeq.strand",
"path" : "MolecularSequence.referenceSeq.strand",
"short" : "watson | crick",
"definition" : "An absolute reference to a strand. The Watson strand is the strand whose 5'-end is on the short arm of the chromosome, and the Crick strand as the one whose 5'-end is on the long arm.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MolecularSequence.referenceSeq.strand",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "strandType"
}],
"strength" : "required",
"description" : "Type for strand.",
"valueSet" : "http://hl7.org/fhir/ValueSet/strand-type|4.0.1"
}
},
{
"id" : "MolecularSequence.referenceSeq.windowStart",
"path" : "MolecularSequence.referenceSeq.windowStart",
"short" : "Start position of the window on the reference sequence",
"definition" : "Start position of the window on the reference sequence. If the coordinate system is either 0-based or 1-based, then start position is inclusive.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MolecularSequence.referenceSeq.windowStart",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "integer"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MolecularSequence.referenceSeq.windowEnd",
"path" : "MolecularSequence.referenceSeq.windowEnd",
"short" : "End position of the window on the reference sequence",
"definition" : "End position of the window on the reference sequence. If the coordinate system is 0-based then end is exclusive and does not include the last position. If the coordinate system is 1-base, then end is inclusive and includes the last position.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MolecularSequence.referenceSeq.windowEnd",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "integer"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MolecularSequence.variant",
"path" : "MolecularSequence.variant",
"short" : "Variant in sequence",
"definition" : "The definition of variant here originates from Sequence ontology ([variant_of](http://www.sequenceontology.org/browser/current_svn/term/variant_of)). This element can represent amino acid or nucleic sequence change(including insertion,deletion,SNP,etc.) It can represent some complex mutation or segment variation with the assist of CIGAR string.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MolecularSequence.variant",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MolecularSequence.variant.id",
"path" : "MolecularSequence.variant.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MolecularSequence.variant.extension",
"path" : "MolecularSequence.variant.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MolecularSequence.variant.modifierExtension",
"path" : "MolecularSequence.variant.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MolecularSequence.variant.start",
"path" : "MolecularSequence.variant.start",
"short" : "Start position of the variant on the reference sequence",
"definition" : "Start position of the variant on the reference sequence. If the coordinate system is either 0-based or 1-based, then start position is inclusive.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MolecularSequence.variant.start",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "integer"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MolecularSequence.variant.end",
"path" : "MolecularSequence.variant.end",
"short" : "End position of the variant on the reference sequence",
"definition" : "End position of the variant on the reference sequence. If the coordinate system is 0-based then end is exclusive and does not include the last position. If the coordinate system is 1-base, then end is inclusive and includes the last position.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MolecularSequence.variant.end",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "integer"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MolecularSequence.variant.observedAllele",
"path" : "MolecularSequence.variant.observedAllele",
"short" : "Allele that was observed",
"definition" : "An allele is one of a set of coexisting sequence variants of a gene ([SO:0001023](http://www.sequenceontology.org/browser/current_svn/term/SO:0001023)). Nucleotide(s)/amino acids from start position of sequence to stop position of sequence on the positive (+) strand of the observed sequence. When the sequence type is DNA, it should be the sequence on the positive (+) strand. This will lay in the range between variant.start and variant.end.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MolecularSequence.variant.observedAllele",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MolecularSequence.variant.referenceAllele",
"path" : "MolecularSequence.variant.referenceAllele",
"short" : "Allele in the reference sequence",
"definition" : "An allele is one of a set of coexisting sequence variants of a gene ([SO:0001023](http://www.sequenceontology.org/browser/current_svn/term/SO:0001023)). Nucleotide(s)/amino acids from start position of sequence to stop position of sequence on the positive (+) strand of the reference sequence. When the sequence type is DNA, it should be the sequence on the positive (+) strand. This will lay in the range between variant.start and variant.end.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MolecularSequence.variant.referenceAllele",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MolecularSequence.variant.cigar",
"path" : "MolecularSequence.variant.cigar",
"short" : "Extended CIGAR string for aligning the sequence with reference bases",
"definition" : "Extended CIGAR string for aligning the sequence with reference bases. See detailed documentation [here](http://support.illumina.com/help/SequencingAnalysisWorkflow/Content/Vault/Informatics/Sequencing_Analysis/CASAVA/swSEQ_mCA_ExtendedCIGARFormat.htm).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MolecularSequence.variant.cigar",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MolecularSequence.variant.variantPointer",
"path" : "MolecularSequence.variant.variantPointer",
"short" : "Pointer to observed variant information",
"definition" : "A pointer to an Observation containing variant information.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MolecularSequence.variant.variantPointer",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Observation"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MolecularSequence.observedSeq",
"path" : "MolecularSequence.observedSeq",
"short" : "Sequence that was observed",
"definition" : "Sequence that was observed. It is the result marked by referenceSeq along with variant records on referenceSeq. This shall start from referenceSeq.windowStart and end by referenceSeq.windowEnd.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MolecularSequence.observedSeq",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MolecularSequence.quality",
"path" : "MolecularSequence.quality",
"short" : "An set of value as quality of sequence",
"definition" : "An experimental feature attribute that defines the quality of the feature in a quantitative way, such as a phred quality score ([SO:0001686](http://www.sequenceontology.org/browser/current_svn/term/SO:0001686)).",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MolecularSequence.quality",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MolecularSequence.quality.id",
"path" : "MolecularSequence.quality.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MolecularSequence.quality.extension",
"path" : "MolecularSequence.quality.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MolecularSequence.quality.modifierExtension",
"path" : "MolecularSequence.quality.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MolecularSequence.quality.type",
"path" : "MolecularSequence.quality.type",
"short" : "indel | snp | unknown",
"definition" : "INDEL / SNP / Undefined variant.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "MolecularSequence.quality.type",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "qualityType"
}],
"strength" : "required",
"description" : "Type for quality report.",
"valueSet" : "http://hl7.org/fhir/ValueSet/quality-type|4.0.1"
}
},
{
"id" : "MolecularSequence.quality.standardSequence",
"path" : "MolecularSequence.quality.standardSequence",
"short" : "Standard sequence for comparison",
"definition" : "Gold standard sequence used for comparing against.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MolecularSequence.quality.standardSequence",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "qualityStandardSequence"
}],
"strength" : "example",
"description" : "Reference identifier of the sequence that used to mark the quality of tested samples.",
"valueSet" : "http://hl7.org/fhir/ValueSet/sequence-quality-standardSequence"
}
},
{
"id" : "MolecularSequence.quality.start",
"path" : "MolecularSequence.quality.start",
"short" : "Start position of the sequence",
"definition" : "Start position of the sequence. If the coordinate system is either 0-based or 1-based, then start position is inclusive.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MolecularSequence.quality.start",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "integer"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MolecularSequence.quality.end",
"path" : "MolecularSequence.quality.end",
"short" : "End position of the sequence",
"definition" : "End position of the sequence. If the coordinate system is 0-based then end is exclusive and does not include the last position. If the coordinate system is 1-base, then end is inclusive and includes the last position.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MolecularSequence.quality.end",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "integer"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MolecularSequence.quality.score",
"path" : "MolecularSequence.quality.score",
"short" : "Quality score for the comparison",
"definition" : "The score of an experimentally derived feature such as a p-value ([SO:0001685](http://www.sequenceontology.org/browser/current_svn/term/SO:0001685)).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MolecularSequence.quality.score",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Quantity"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MolecularSequence.quality.method",
"path" : "MolecularSequence.quality.method",
"short" : "Method to get quality",
"definition" : "Which method is used to get sequence quality.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MolecularSequence.quality.method",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "qualityMethod"
}],
"strength" : "example",
"description" : "The method used to evaluate the numerical quality of the observed sequence.",
"valueSet" : "http://hl7.org/fhir/ValueSet/sequence-quality-method"
}
},
{
"id" : "MolecularSequence.quality.truthTP",
"path" : "MolecularSequence.quality.truthTP",
"short" : "True positives from the perspective of the truth data",
"definition" : "True positives, from the perspective of the truth data, i.e. the number of sites in the Truth Call Set for which there are paths through the Query Call Set that are consistent with all of the alleles at this site, and for which there is an accurate genotype call for the event.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MolecularSequence.quality.truthTP",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "decimal"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MolecularSequence.quality.queryTP",
"path" : "MolecularSequence.quality.queryTP",
"short" : "True positives from the perspective of the query data",
"definition" : "True positives, from the perspective of the query data, i.e. the number of sites in the Query Call Set for which there are paths through the Truth Call Set that are consistent with all of the alleles at this site, and for which there is an accurate genotype call for the event.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MolecularSequence.quality.queryTP",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "decimal"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MolecularSequence.quality.truthFN",
"path" : "MolecularSequence.quality.truthFN",
"short" : "False negatives",
"definition" : "False negatives, i.e. the number of sites in the Truth Call Set for which there is no path through the Query Call Set that is consistent with all of the alleles at this site, or sites for which there is an inaccurate genotype call for the event. Sites with correct variant but incorrect genotype are counted here.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MolecularSequence.quality.truthFN",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "decimal"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MolecularSequence.quality.queryFP",
"path" : "MolecularSequence.quality.queryFP",
"short" : "False positives",
"definition" : "False positives, i.e. the number of sites in the Query Call Set for which there is no path through the Truth Call Set that is consistent with this site. Sites with correct variant but incorrect genotype are counted here.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MolecularSequence.quality.queryFP",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "decimal"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MolecularSequence.quality.gtFP",
"path" : "MolecularSequence.quality.gtFP",
"short" : "False positives where the non-REF alleles in the Truth and Query Call Sets match",
"definition" : "The number of false positives where the non-REF alleles in the Truth and Query Call Sets match (i.e. cases where the truth is 1/1 and the query is 0/1 or similar).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MolecularSequence.quality.gtFP",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "decimal"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MolecularSequence.quality.precision",
"path" : "MolecularSequence.quality.precision",
"short" : "Precision of comparison",
"definition" : "QUERY.TP / (QUERY.TP + QUERY.FP).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MolecularSequence.quality.precision",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "decimal"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MolecularSequence.quality.recall",
"path" : "MolecularSequence.quality.recall",
"short" : "Recall of comparison",
"definition" : "TRUTH.TP / (TRUTH.TP + TRUTH.FN).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MolecularSequence.quality.recall",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "decimal"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MolecularSequence.quality.fScore",
"path" : "MolecularSequence.quality.fScore",
"short" : "F-score",
"definition" : "Harmonic mean of Recall and Precision, computed as: 2 * precision * recall / (precision + recall).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MolecularSequence.quality.fScore",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "decimal"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MolecularSequence.quality.roc",
"path" : "MolecularSequence.quality.roc",
"short" : "Receiver Operator Characteristic (ROC) Curve",
"definition" : "Receiver Operator Characteristic (ROC) Curve to give sensitivity/specificity tradeoff.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MolecularSequence.quality.roc",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MolecularSequence.quality.roc.id",
"path" : "MolecularSequence.quality.roc.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MolecularSequence.quality.roc.extension",
"path" : "MolecularSequence.quality.roc.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MolecularSequence.quality.roc.modifierExtension",
"path" : "MolecularSequence.quality.roc.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MolecularSequence.quality.roc.score",
"path" : "MolecularSequence.quality.roc.score",
"short" : "Genotype quality score",
"definition" : "Invidual data point representing the GQ (genotype quality) score threshold.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MolecularSequence.quality.roc.score",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "integer"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MolecularSequence.quality.roc.numTP",
"path" : "MolecularSequence.quality.roc.numTP",
"short" : "Roc score true positive numbers",
"definition" : "The number of true positives if the GQ score threshold was set to \"score\" field value.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MolecularSequence.quality.roc.numTP",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "integer"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MolecularSequence.quality.roc.numFP",
"path" : "MolecularSequence.quality.roc.numFP",
"short" : "Roc score false positive numbers",
"definition" : "The number of false positives if the GQ score threshold was set to \"score\" field value.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MolecularSequence.quality.roc.numFP",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "integer"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MolecularSequence.quality.roc.numFN",
"path" : "MolecularSequence.quality.roc.numFN",
"short" : "Roc score false negative numbers",
"definition" : "The number of false negatives if the GQ score threshold was set to \"score\" field value.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MolecularSequence.quality.roc.numFN",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "integer"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MolecularSequence.quality.roc.precision",
"path" : "MolecularSequence.quality.roc.precision",
"short" : "Precision of the GQ score",
"definition" : "Calculated precision if the GQ score threshold was set to \"score\" field value.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MolecularSequence.quality.roc.precision",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "decimal"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MolecularSequence.quality.roc.sensitivity",
"path" : "MolecularSequence.quality.roc.sensitivity",
"short" : "Sensitivity of the GQ score",
"definition" : "Calculated sensitivity if the GQ score threshold was set to \"score\" field value.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MolecularSequence.quality.roc.sensitivity",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "decimal"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MolecularSequence.quality.roc.fMeasure",
"path" : "MolecularSequence.quality.roc.fMeasure",
"short" : "FScore of the GQ score",
"definition" : "Calculated fScore if the GQ score threshold was set to \"score\" field value.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MolecularSequence.quality.roc.fMeasure",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "decimal"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MolecularSequence.readCoverage",
"path" : "MolecularSequence.readCoverage",
"short" : "Average number of reads representing a given nucleotide in the reconstructed sequence",
"definition" : "Coverage (read depth or depth) is the average number of reads representing a given nucleotide in the reconstructed sequence.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MolecularSequence.readCoverage",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "integer"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MolecularSequence.repository",
"path" : "MolecularSequence.repository",
"short" : "External repository which contains detailed report related with observedSeq in this resource",
"definition" : "Configurations of the external repository. The repository shall store target's observedSeq or records related with target's observedSeq.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MolecularSequence.repository",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MolecularSequence.repository.id",
"path" : "MolecularSequence.repository.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MolecularSequence.repository.extension",
"path" : "MolecularSequence.repository.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MolecularSequence.repository.modifierExtension",
"path" : "MolecularSequence.repository.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MolecularSequence.repository.type",
"path" : "MolecularSequence.repository.type",
"short" : "directlink | openapi | login | oauth | other",
"definition" : "Click and see / RESTful API / Need login to see / RESTful API with authentication / Other ways to see resource.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "MolecularSequence.repository.type",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "repositoryType"
}],
"strength" : "required",
"description" : "Type for access of external URI.",
"valueSet" : "http://hl7.org/fhir/ValueSet/repository-type|4.0.1"
}
},
{
"id" : "MolecularSequence.repository.url",
"path" : "MolecularSequence.repository.url",
"short" : "URI of the repository",
"definition" : "URI of an external repository which contains further details about the genetics data.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MolecularSequence.repository.url",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MolecularSequence.repository.name",
"path" : "MolecularSequence.repository.name",
"short" : "Repository's name",
"definition" : "URI of an external repository which contains further details about the genetics data.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MolecularSequence.repository.name",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MolecularSequence.repository.datasetId",
"path" : "MolecularSequence.repository.datasetId",
"short" : "Id of the dataset that used to call for dataset in repository",
"definition" : "Id of the variant in this external repository. The server will understand how to use this id to call for more info about datasets in external repository.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MolecularSequence.repository.datasetId",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MolecularSequence.repository.variantsetId",
"path" : "MolecularSequence.repository.variantsetId",
"short" : "Id of the variantset that used to call for variantset in repository",
"definition" : "Id of the variantset in this external repository. The server will understand how to use this id to call for more info about variantsets in external repository.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MolecularSequence.repository.variantsetId",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MolecularSequence.repository.readsetId",
"path" : "MolecularSequence.repository.readsetId",
"short" : "Id of the read",
"definition" : "Id of the read in this external repository.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MolecularSequence.repository.readsetId",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MolecularSequence.pointer",
"path" : "MolecularSequence.pointer",
"short" : "Pointer to next atomic sequence",
"definition" : "Pointer to next atomic sequence which at most contains one variant.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MolecularSequence.pointer",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/MolecularSequence"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MolecularSequence.structureVariant",
"path" : "MolecularSequence.structureVariant",
"short" : "Structural variant",
"definition" : "Information about chromosome structure variation.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MolecularSequence.structureVariant",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MolecularSequence.structureVariant.id",
"path" : "MolecularSequence.structureVariant.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MolecularSequence.structureVariant.extension",
"path" : "MolecularSequence.structureVariant.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MolecularSequence.structureVariant.modifierExtension",
"path" : "MolecularSequence.structureVariant.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MolecularSequence.structureVariant.variantType",
"path" : "MolecularSequence.structureVariant.variantType",
"short" : "Structural variant change type",
"definition" : "Information about chromosome structure variation DNA change type.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MolecularSequence.structureVariant.variantType",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "LOINC LL379-9 answerlist"
}],
"strength" : "required",
"description" : "DNA change type.",
"valueSet" : "http://loinc.org/vs/LL379-9|4.0.1"
}
},
{
"id" : "MolecularSequence.structureVariant.exact",
"path" : "MolecularSequence.structureVariant.exact",
"short" : "Does the structural variant have base pair resolution breakpoints?",
"definition" : "Used to indicate if the outer and inner start-end values have the same meaning.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MolecularSequence.structureVariant.exact",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MolecularSequence.structureVariant.length",
"path" : "MolecularSequence.structureVariant.length",
"short" : "Structural variant length",
"definition" : "Length of the variant chromosome.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MolecularSequence.structureVariant.length",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "integer"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MolecularSequence.structureVariant.outer",
"path" : "MolecularSequence.structureVariant.outer",
"short" : "Structural variant outer",
"definition" : "Structural variant outer.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MolecularSequence.structureVariant.outer",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MolecularSequence.structureVariant.outer.id",
"path" : "MolecularSequence.structureVariant.outer.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MolecularSequence.structureVariant.outer.extension",
"path" : "MolecularSequence.structureVariant.outer.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MolecularSequence.structureVariant.outer.modifierExtension",
"path" : "MolecularSequence.structureVariant.outer.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MolecularSequence.structureVariant.outer.start",
"path" : "MolecularSequence.structureVariant.outer.start",
"short" : "Structural variant outer start",
"definition" : "Structural variant outer start. If the coordinate system is either 0-based or 1-based, then start position is inclusive.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MolecularSequence.structureVariant.outer.start",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "integer"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MolecularSequence.structureVariant.outer.end",
"path" : "MolecularSequence.structureVariant.outer.end",
"short" : "Structural variant outer end",
"definition" : "Structural variant outer end. If the coordinate system is 0-based then end is exclusive and does not include the last position. If the coordinate system is 1-base, then end is inclusive and includes the last position.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MolecularSequence.structureVariant.outer.end",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "integer"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MolecularSequence.structureVariant.inner",
"path" : "MolecularSequence.structureVariant.inner",
"short" : "Structural variant inner",
"definition" : "Structural variant inner.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MolecularSequence.structureVariant.inner",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MolecularSequence.structureVariant.inner.id",
"path" : "MolecularSequence.structureVariant.inner.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MolecularSequence.structureVariant.inner.extension",
"path" : "MolecularSequence.structureVariant.inner.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "MolecularSequence.structureVariant.inner.modifierExtension",
"path" : "MolecularSequence.structureVariant.inner.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MolecularSequence.structureVariant.inner.start",
"path" : "MolecularSequence.structureVariant.inner.start",
"short" : "Structural variant inner start",
"definition" : "Structural variant inner start. If the coordinate system is either 0-based or 1-based, then start position is inclusive.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MolecularSequence.structureVariant.inner.start",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "integer"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MolecularSequence.structureVariant.inner.end",
"path" : "MolecularSequence.structureVariant.inner.end",
"short" : "Structural variant inner end",
"definition" : "Structural variant inner end. If the coordinate system is 0-based then end is exclusive and does not include the last position. If the coordinate system is 1-base, then end is inclusive and includes the last position.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MolecularSequence.structureVariant.inner.end",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "integer"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
}]
},
"differential" : {
"element" : [{
"id" : "MolecularSequence",
"path" : "MolecularSequence",
"short" : "Information about a biological sequence",
"definition" : "Raw data describing a biological sequence.",
"min" : 0,
"max" : "*",
"constraint" : [{
"key" : "msq-3",
"severity" : "error",
"human" : "Only 0 and 1 are valid for coordinateSystem",
"expression" : "coordinateSystem = 1 or coordinateSystem = 0",
"xpath" : "count(f:coordinateSystem[@value=0 and @value=1]) = 1"
}]
},
{
"id" : "MolecularSequence.identifier",
"path" : "MolecularSequence.identifier",
"short" : "Unique ID for this particular sequence. This is a FHIR-defined id",
"definition" : "A unique identifier for this particular sequence instance. This is a FHIR-defined id.",
"requirements" : "Allows sequences to be distinguished and referenced.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Identifier"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.identifier"
}]
},
{
"id" : "MolecularSequence.type",
"path" : "MolecularSequence.type",
"short" : "aa | dna | rna",
"definition" : "Amino Acid Sequence/ DNA Sequence / RNA Sequence.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "sequenceType"
}],
"strength" : "required",
"description" : "Type if a sequence -- DNA, RNA, or amino acid sequence.",
"valueSet" : "http://hl7.org/fhir/ValueSet/sequence-type|4.0.1"
}
},
{
"id" : "MolecularSequence.coordinateSystem",
"path" : "MolecularSequence.coordinateSystem",
"short" : "Base number of coordinate system (0 for 0-based numbering or coordinates, inclusive start, exclusive end, 1 for 1-based numbering, inclusive start, inclusive end)",
"definition" : "Whether the sequence is numbered starting at 0 (0-based numbering or coordinates, inclusive start, exclusive end) or starting at 1 (1-based numbering, inclusive start and inclusive end).",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "integer"
}],
"isSummary" : true
},
{
"id" : "MolecularSequence.patient",
"path" : "MolecularSequence.patient",
"short" : "Who and/or what this is about",
"definition" : "The patient whose sequencing results are described by this resource.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient"]
}],
"isSummary" : true
},
{
"id" : "MolecularSequence.specimen",
"path" : "MolecularSequence.specimen",
"short" : "Specimen used for sequencing",
"definition" : "Specimen used for sequencing.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Specimen"]
}],
"isSummary" : true
},
{
"id" : "MolecularSequence.device",
"path" : "MolecularSequence.device",
"short" : "The method for sequencing",
"definition" : "The method for sequencing, for example, chip information.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Device"]
}],
"isSummary" : true
},
{
"id" : "MolecularSequence.performer",
"path" : "MolecularSequence.performer",
"short" : "Who should be responsible for test result",
"definition" : "The organization or lab that should be responsible for this result.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"isSummary" : true
},
{
"id" : "MolecularSequence.quantity",
"path" : "MolecularSequence.quantity",
"short" : "The number of copies of the sequence of interest. (RNASeq)",
"definition" : "The number of copies of the sequence of interest. (RNASeq).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Quantity"
}],
"isSummary" : true
},
{
"id" : "MolecularSequence.referenceSeq",
"path" : "MolecularSequence.referenceSeq",
"short" : "A sequence used as reference",
"definition" : "A sequence that is used as a reference to describe variants that are present in a sequence analyzed.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "msq-6",
"severity" : "error",
"human" : "Have and only have one of the following elements in referenceSeq : 1. genomeBuild ; 2 referenceSeqId; 3. referenceSeqPointer; 4. referenceSeqString;",
"expression" : "(genomeBuild.count()+referenceSeqId.count()+ referenceSeqPointer.count()+ referenceSeqString.count()) = 1",
"xpath" : "count(f:genomeBuild)+count(f:referenceSeqId)+count(f:referenceSeqPointer)+count(f:referenceSeqString)=1"
},
{
"key" : "msq-5",
"severity" : "error",
"human" : "GenomeBuild and chromosome must be both contained if either one of them is contained",
"expression" : "(chromosome.empty() and genomeBuild.empty()) or (chromosome.exists() and genomeBuild.exists())",
"xpath" : "(exists(f:chromosome) and exists(f:genomeBuild)) or (not(exists(f:chromosome)) and not(exists(f:genomeBuild)))"
}],
"isSummary" : true
},
{
"id" : "MolecularSequence.referenceSeq.chromosome",
"path" : "MolecularSequence.referenceSeq.chromosome",
"short" : "Chromosome containing genetic finding",
"definition" : "Structural unit composed of a nucleic acid molecule which controls its own replication through the interaction of specific proteins at one or more origins of replication ([SO:0000340](http://www.sequenceontology.org/browser/current_svn/term/SO:0000340)).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "chromosome-human"
}],
"strength" : "example",
"description" : "Chromosome number for human.",
"valueSet" : "http://hl7.org/fhir/ValueSet/chromosome-human"
}
},
{
"id" : "MolecularSequence.referenceSeq.genomeBuild",
"path" : "MolecularSequence.referenceSeq.genomeBuild",
"short" : "The Genome Build used for reference, following GRCh build versions e.g. 'GRCh 37'",
"definition" : "The Genome Build used for reference, following GRCh build versions e.g. 'GRCh 37'. Version number must be included if a versioned release of a primary build was used.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "MolecularSequence.referenceSeq.orientation",
"path" : "MolecularSequence.referenceSeq.orientation",
"short" : "sense | antisense",
"definition" : "A relative reference to a DNA strand based on gene orientation. The strand that contains the open reading frame of the gene is the \"sense\" strand, and the opposite complementary strand is the \"antisense\" strand.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "orientationType"
}],
"strength" : "required",
"description" : "Type for orientation.",
"valueSet" : "http://hl7.org/fhir/ValueSet/orientation-type|4.0.1"
}
},
{
"id" : "MolecularSequence.referenceSeq.referenceSeqId",
"path" : "MolecularSequence.referenceSeq.referenceSeqId",
"short" : "Reference identifier",
"definition" : "Reference identifier of reference sequence submitted to NCBI. It must match the type in the MolecularSequence.type field. For example, the prefix, “NG_” identifies reference sequence for genes, “NM_” for messenger RNA transcripts, and “NP_” for amino acid sequences.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "sequenceReference"
}],
"strength" : "example",
"description" : "Reference identifier.",
"valueSet" : "http://hl7.org/fhir/ValueSet/sequence-referenceSeq"
}
},
{
"id" : "MolecularSequence.referenceSeq.referenceSeqPointer",
"path" : "MolecularSequence.referenceSeq.referenceSeqPointer",
"short" : "A pointer to another MolecularSequence entity as reference sequence",
"definition" : "A pointer to another MolecularSequence entity as reference sequence.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/MolecularSequence"]
}],
"isSummary" : true
},
{
"id" : "MolecularSequence.referenceSeq.referenceSeqString",
"path" : "MolecularSequence.referenceSeq.referenceSeqString",
"short" : "A string to represent reference sequence",
"definition" : "A string like \"ACGT\".",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "MolecularSequence.referenceSeq.strand",
"path" : "MolecularSequence.referenceSeq.strand",
"short" : "watson | crick",
"definition" : "An absolute reference to a strand. The Watson strand is the strand whose 5'-end is on the short arm of the chromosome, and the Crick strand as the one whose 5'-end is on the long arm.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "strandType"
}],
"strength" : "required",
"description" : "Type for strand.",
"valueSet" : "http://hl7.org/fhir/ValueSet/strand-type|4.0.1"
}
},
{
"id" : "MolecularSequence.referenceSeq.windowStart",
"path" : "MolecularSequence.referenceSeq.windowStart",
"short" : "Start position of the window on the reference sequence",
"definition" : "Start position of the window on the reference sequence. If the coordinate system is either 0-based or 1-based, then start position is inclusive.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "integer"
}],
"isSummary" : true
},
{
"id" : "MolecularSequence.referenceSeq.windowEnd",
"path" : "MolecularSequence.referenceSeq.windowEnd",
"short" : "End position of the window on the reference sequence",
"definition" : "End position of the window on the reference sequence. If the coordinate system is 0-based then end is exclusive and does not include the last position. If the coordinate system is 1-base, then end is inclusive and includes the last position.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "integer"
}],
"isSummary" : true
},
{
"id" : "MolecularSequence.variant",
"path" : "MolecularSequence.variant",
"short" : "Variant in sequence",
"definition" : "The definition of variant here originates from Sequence ontology ([variant_of](http://www.sequenceontology.org/browser/current_svn/term/variant_of)). This element can represent amino acid or nucleic sequence change(including insertion,deletion,SNP,etc.) It can represent some complex mutation or segment variation with the assist of CIGAR string.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"isSummary" : true
},
{
"id" : "MolecularSequence.variant.start",
"path" : "MolecularSequence.variant.start",
"short" : "Start position of the variant on the reference sequence",
"definition" : "Start position of the variant on the reference sequence. If the coordinate system is either 0-based or 1-based, then start position is inclusive.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "integer"
}],
"isSummary" : true
},
{
"id" : "MolecularSequence.variant.end",
"path" : "MolecularSequence.variant.end",
"short" : "End position of the variant on the reference sequence",
"definition" : "End position of the variant on the reference sequence. If the coordinate system is 0-based then end is exclusive and does not include the last position. If the coordinate system is 1-base, then end is inclusive and includes the last position.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "integer"
}],
"isSummary" : true
},
{
"id" : "MolecularSequence.variant.observedAllele",
"path" : "MolecularSequence.variant.observedAllele",
"short" : "Allele that was observed",
"definition" : "An allele is one of a set of coexisting sequence variants of a gene ([SO:0001023](http://www.sequenceontology.org/browser/current_svn/term/SO:0001023)). Nucleotide(s)/amino acids from start position of sequence to stop position of sequence on the positive (+) strand of the observed sequence. When the sequence type is DNA, it should be the sequence on the positive (+) strand. This will lay in the range between variant.start and variant.end.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "MolecularSequence.variant.referenceAllele",
"path" : "MolecularSequence.variant.referenceAllele",
"short" : "Allele in the reference sequence",
"definition" : "An allele is one of a set of coexisting sequence variants of a gene ([SO:0001023](http://www.sequenceontology.org/browser/current_svn/term/SO:0001023)). Nucleotide(s)/amino acids from start position of sequence to stop position of sequence on the positive (+) strand of the reference sequence. When the sequence type is DNA, it should be the sequence on the positive (+) strand. This will lay in the range between variant.start and variant.end.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "MolecularSequence.variant.cigar",
"path" : "MolecularSequence.variant.cigar",
"short" : "Extended CIGAR string for aligning the sequence with reference bases",
"definition" : "Extended CIGAR string for aligning the sequence with reference bases. See detailed documentation [here](http://support.illumina.com/help/SequencingAnalysisWorkflow/Content/Vault/Informatics/Sequencing_Analysis/CASAVA/swSEQ_mCA_ExtendedCIGARFormat.htm).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "MolecularSequence.variant.variantPointer",
"path" : "MolecularSequence.variant.variantPointer",
"short" : "Pointer to observed variant information",
"definition" : "A pointer to an Observation containing variant information.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Observation"]
}],
"isSummary" : true
},
{
"id" : "MolecularSequence.observedSeq",
"path" : "MolecularSequence.observedSeq",
"short" : "Sequence that was observed",
"definition" : "Sequence that was observed. It is the result marked by referenceSeq along with variant records on referenceSeq. This shall start from referenceSeq.windowStart and end by referenceSeq.windowEnd.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "MolecularSequence.quality",
"path" : "MolecularSequence.quality",
"short" : "An set of value as quality of sequence",
"definition" : "An experimental feature attribute that defines the quality of the feature in a quantitative way, such as a phred quality score ([SO:0001686](http://www.sequenceontology.org/browser/current_svn/term/SO:0001686)).",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"isSummary" : true
},
{
"id" : "MolecularSequence.quality.type",
"path" : "MolecularSequence.quality.type",
"short" : "indel | snp | unknown",
"definition" : "INDEL / SNP / Undefined variant.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "qualityType"
}],
"strength" : "required",
"description" : "Type for quality report.",
"valueSet" : "http://hl7.org/fhir/ValueSet/quality-type|4.0.1"
}
},
{
"id" : "MolecularSequence.quality.standardSequence",
"path" : "MolecularSequence.quality.standardSequence",
"short" : "Standard sequence for comparison",
"definition" : "Gold standard sequence used for comparing against.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "qualityStandardSequence"
}],
"strength" : "example",
"description" : "Reference identifier of the sequence that used to mark the quality of tested samples.",
"valueSet" : "http://hl7.org/fhir/ValueSet/sequence-quality-standardSequence"
}
},
{
"id" : "MolecularSequence.quality.start",
"path" : "MolecularSequence.quality.start",
"short" : "Start position of the sequence",
"definition" : "Start position of the sequence. If the coordinate system is either 0-based or 1-based, then start position is inclusive.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "integer"
}],
"isSummary" : true
},
{
"id" : "MolecularSequence.quality.end",
"path" : "MolecularSequence.quality.end",
"short" : "End position of the sequence",
"definition" : "End position of the sequence. If the coordinate system is 0-based then end is exclusive and does not include the last position. If the coordinate system is 1-base, then end is inclusive and includes the last position.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "integer"
}],
"isSummary" : true
},
{
"id" : "MolecularSequence.quality.score",
"path" : "MolecularSequence.quality.score",
"short" : "Quality score for the comparison",
"definition" : "The score of an experimentally derived feature such as a p-value ([SO:0001685](http://www.sequenceontology.org/browser/current_svn/term/SO:0001685)).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Quantity"
}],
"isSummary" : true
},
{
"id" : "MolecularSequence.quality.method",
"path" : "MolecularSequence.quality.method",
"short" : "Method to get quality",
"definition" : "Which method is used to get sequence quality.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "qualityMethod"
}],
"strength" : "example",
"description" : "The method used to evaluate the numerical quality of the observed sequence.",
"valueSet" : "http://hl7.org/fhir/ValueSet/sequence-quality-method"
}
},
{
"id" : "MolecularSequence.quality.truthTP",
"path" : "MolecularSequence.quality.truthTP",
"short" : "True positives from the perspective of the truth data",
"definition" : "True positives, from the perspective of the truth data, i.e. the number of sites in the Truth Call Set for which there are paths through the Query Call Set that are consistent with all of the alleles at this site, and for which there is an accurate genotype call for the event.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "decimal"
}],
"isSummary" : true
},
{
"id" : "MolecularSequence.quality.queryTP",
"path" : "MolecularSequence.quality.queryTP",
"short" : "True positives from the perspective of the query data",
"definition" : "True positives, from the perspective of the query data, i.e. the number of sites in the Query Call Set for which there are paths through the Truth Call Set that are consistent with all of the alleles at this site, and for which there is an accurate genotype call for the event.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "decimal"
}],
"isSummary" : true
},
{
"id" : "MolecularSequence.quality.truthFN",
"path" : "MolecularSequence.quality.truthFN",
"short" : "False negatives",
"definition" : "False negatives, i.e. the number of sites in the Truth Call Set for which there is no path through the Query Call Set that is consistent with all of the alleles at this site, or sites for which there is an inaccurate genotype call for the event. Sites with correct variant but incorrect genotype are counted here.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "decimal"
}],
"isSummary" : true
},
{
"id" : "MolecularSequence.quality.queryFP",
"path" : "MolecularSequence.quality.queryFP",
"short" : "False positives",
"definition" : "False positives, i.e. the number of sites in the Query Call Set for which there is no path through the Truth Call Set that is consistent with this site. Sites with correct variant but incorrect genotype are counted here.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "decimal"
}],
"isSummary" : true
},
{
"id" : "MolecularSequence.quality.gtFP",
"path" : "MolecularSequence.quality.gtFP",
"short" : "False positives where the non-REF alleles in the Truth and Query Call Sets match",
"definition" : "The number of false positives where the non-REF alleles in the Truth and Query Call Sets match (i.e. cases where the truth is 1/1 and the query is 0/1 or similar).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "decimal"
}],
"isSummary" : true
},
{
"id" : "MolecularSequence.quality.precision",
"path" : "MolecularSequence.quality.precision",
"short" : "Precision of comparison",
"definition" : "QUERY.TP / (QUERY.TP + QUERY.FP).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "decimal"
}],
"isSummary" : true
},
{
"id" : "MolecularSequence.quality.recall",
"path" : "MolecularSequence.quality.recall",
"short" : "Recall of comparison",
"definition" : "TRUTH.TP / (TRUTH.TP + TRUTH.FN).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "decimal"
}],
"isSummary" : true
},
{
"id" : "MolecularSequence.quality.fScore",
"path" : "MolecularSequence.quality.fScore",
"short" : "F-score",
"definition" : "Harmonic mean of Recall and Precision, computed as: 2 * precision * recall / (precision + recall).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "decimal"
}],
"isSummary" : true
},
{
"id" : "MolecularSequence.quality.roc",
"path" : "MolecularSequence.quality.roc",
"short" : "Receiver Operator Characteristic (ROC) Curve",
"definition" : "Receiver Operator Characteristic (ROC) Curve to give sensitivity/specificity tradeoff.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "BackboneElement"
}],
"isSummary" : true
},
{
"id" : "MolecularSequence.quality.roc.score",
"path" : "MolecularSequence.quality.roc.score",
"short" : "Genotype quality score",
"definition" : "Invidual data point representing the GQ (genotype quality) score threshold.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "integer"
}],
"isSummary" : true
},
{
"id" : "MolecularSequence.quality.roc.numTP",
"path" : "MolecularSequence.quality.roc.numTP",
"short" : "Roc score true positive numbers",
"definition" : "The number of true positives if the GQ score threshold was set to \"score\" field value.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "integer"
}],
"isSummary" : true
},
{
"id" : "MolecularSequence.quality.roc.numFP",
"path" : "MolecularSequence.quality.roc.numFP",
"short" : "Roc score false positive numbers",
"definition" : "The number of false positives if the GQ score threshold was set to \"score\" field value.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "integer"
}],
"isSummary" : true
},
{
"id" : "MolecularSequence.quality.roc.numFN",
"path" : "MolecularSequence.quality.roc.numFN",
"short" : "Roc score false negative numbers",
"definition" : "The number of false negatives if the GQ score threshold was set to \"score\" field value.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "integer"
}],
"isSummary" : true
},
{
"id" : "MolecularSequence.quality.roc.precision",
"path" : "MolecularSequence.quality.roc.precision",
"short" : "Precision of the GQ score",
"definition" : "Calculated precision if the GQ score threshold was set to \"score\" field value.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "decimal"
}],
"isSummary" : true
},
{
"id" : "MolecularSequence.quality.roc.sensitivity",
"path" : "MolecularSequence.quality.roc.sensitivity",
"short" : "Sensitivity of the GQ score",
"definition" : "Calculated sensitivity if the GQ score threshold was set to \"score\" field value.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "decimal"
}],
"isSummary" : true
},
{
"id" : "MolecularSequence.quality.roc.fMeasure",
"path" : "MolecularSequence.quality.roc.fMeasure",
"short" : "FScore of the GQ score",
"definition" : "Calculated fScore if the GQ score threshold was set to \"score\" field value.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "decimal"
}],
"isSummary" : true
},
{
"id" : "MolecularSequence.readCoverage",
"path" : "MolecularSequence.readCoverage",
"short" : "Average number of reads representing a given nucleotide in the reconstructed sequence",
"definition" : "Coverage (read depth or depth) is the average number of reads representing a given nucleotide in the reconstructed sequence.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "integer"
}],
"isSummary" : true
},
{
"id" : "MolecularSequence.repository",
"path" : "MolecularSequence.repository",
"short" : "External repository which contains detailed report related with observedSeq in this resource",
"definition" : "Configurations of the external repository. The repository shall store target's observedSeq or records related with target's observedSeq.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"isSummary" : true
},
{
"id" : "MolecularSequence.repository.type",
"path" : "MolecularSequence.repository.type",
"short" : "directlink | openapi | login | oauth | other",
"definition" : "Click and see / RESTful API / Need login to see / RESTful API with authentication / Other ways to see resource.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "repositoryType"
}],
"strength" : "required",
"description" : "Type for access of external URI.",
"valueSet" : "http://hl7.org/fhir/ValueSet/repository-type|4.0.1"
}
},
{
"id" : "MolecularSequence.repository.url",
"path" : "MolecularSequence.repository.url",
"short" : "URI of the repository",
"definition" : "URI of an external repository which contains further details about the genetics data.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "uri"
}],
"isSummary" : true
},
{
"id" : "MolecularSequence.repository.name",
"path" : "MolecularSequence.repository.name",
"short" : "Repository's name",
"definition" : "URI of an external repository which contains further details about the genetics data.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "MolecularSequence.repository.datasetId",
"path" : "MolecularSequence.repository.datasetId",
"short" : "Id of the dataset that used to call for dataset in repository",
"definition" : "Id of the variant in this external repository. The server will understand how to use this id to call for more info about datasets in external repository.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "MolecularSequence.repository.variantsetId",
"path" : "MolecularSequence.repository.variantsetId",
"short" : "Id of the variantset that used to call for variantset in repository",
"definition" : "Id of the variantset in this external repository. The server will understand how to use this id to call for more info about variantsets in external repository.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "MolecularSequence.repository.readsetId",
"path" : "MolecularSequence.repository.readsetId",
"short" : "Id of the read",
"definition" : "Id of the read in this external repository.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "MolecularSequence.pointer",
"path" : "MolecularSequence.pointer",
"short" : "Pointer to next atomic sequence",
"definition" : "Pointer to next atomic sequence which at most contains one variant.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/MolecularSequence"]
}],
"isSummary" : true
},
{
"id" : "MolecularSequence.structureVariant",
"path" : "MolecularSequence.structureVariant",
"short" : "Structural variant",
"definition" : "Information about chromosome structure variation.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"isSummary" : true
},
{
"id" : "MolecularSequence.structureVariant.variantType",
"path" : "MolecularSequence.structureVariant.variantType",
"short" : "Structural variant change type",
"definition" : "Information about chromosome structure variation DNA change type.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "LOINC LL379-9 answerlist"
}],
"strength" : "required",
"description" : "DNA change type.",
"valueSet" : "http://loinc.org/vs/LL379-9|4.0.1"
}
},
{
"id" : "MolecularSequence.structureVariant.exact",
"path" : "MolecularSequence.structureVariant.exact",
"short" : "Does the structural variant have base pair resolution breakpoints?",
"definition" : "Used to indicate if the outer and inner start-end values have the same meaning.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "boolean"
}],
"isSummary" : true
},
{
"id" : "MolecularSequence.structureVariant.length",
"path" : "MolecularSequence.structureVariant.length",
"short" : "Structural variant length",
"definition" : "Length of the variant chromosome.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "integer"
}],
"isSummary" : true
},
{
"id" : "MolecularSequence.structureVariant.outer",
"path" : "MolecularSequence.structureVariant.outer",
"short" : "Structural variant outer",
"definition" : "Structural variant outer.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "BackboneElement"
}],
"isSummary" : true
},
{
"id" : "MolecularSequence.structureVariant.outer.start",
"path" : "MolecularSequence.structureVariant.outer.start",
"short" : "Structural variant outer start",
"definition" : "Structural variant outer start. If the coordinate system is either 0-based or 1-based, then start position is inclusive.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "integer"
}],
"isSummary" : true
},
{
"id" : "MolecularSequence.structureVariant.outer.end",
"path" : "MolecularSequence.structureVariant.outer.end",
"short" : "Structural variant outer end",
"definition" : "Structural variant outer end. If the coordinate system is 0-based then end is exclusive and does not include the last position. If the coordinate system is 1-base, then end is inclusive and includes the last position.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "integer"
}],
"isSummary" : true
},
{
"id" : "MolecularSequence.structureVariant.inner",
"path" : "MolecularSequence.structureVariant.inner",
"short" : "Structural variant inner",
"definition" : "Structural variant inner.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "BackboneElement"
}],
"isSummary" : true
},
{
"id" : "MolecularSequence.structureVariant.inner.start",
"path" : "MolecularSequence.structureVariant.inner.start",
"short" : "Structural variant inner start",
"definition" : "Structural variant inner start. If the coordinate system is either 0-based or 1-based, then start position is inclusive.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "integer"
}],
"isSummary" : true
},
{
"id" : "MolecularSequence.structureVariant.inner.end",
"path" : "MolecularSequence.structureVariant.inner.end",
"short" : "Structural variant inner end",
"definition" : "Structural variant inner end. If the coordinate system is 0-based then end is exclusive and does not include the last position. If the coordinate system is 1-base, then end is inclusive and includes the last position.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "integer"
}],
"isSummary" : true
}]
}
}
},
{
"fullUrl" : "http://hl7.org/fhir/StructureDefinition/NamingSystem",
"resource" : {
"resourceType" : "StructureDefinition",
"id" : "NamingSystem",
"meta" : {
"lastUpdated" : "2019-11-01T09:29:23.356+11:00"
},
"text" : {
"status" : "generated",
"div" : "Name Flags Card. Type Description & Constraints NamingSystem ITU 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
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension name ΣI 1..1 string Name for this naming system (computer friendly) status ?!Σ 1..1 code draft | active | retired | unknown
PublicationStatus (Required) kind Σ 1..1 code codesystem | identifier | root
NamingSystemType (Required) date Σ 1..1 dateTime Date last changed publisher Σ 0..1 string Name of the publisher (organization or individual) contact Σ 0..* ContactDetail Contact details for the publisher
responsible 0..1 string Who maintains system namespace? type 0..1 CodeableConcept e.g. driver, provider, patient, bank etc.
IdentifierType (Extensible) description 0..1 markdown Natural language description of the naming system useContext Σ 0..* UsageContext The context that the content is intended to support
jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for naming system (if applicable)
Jurisdiction (Extensible)
usage 0..1 string How/where is it used uniqueId Σ 1..* BackboneElement Unique identifiers used for system
type Σ 1..1 code oid | uuid | uri | other
NamingSystemIdentifierType (Required) value Σ 1..1 string The unique identifier preferred 0..1 boolean Is this the id that should be used for this type comment 0..1 string Notes about identifier usage period 0..1 Period When is identifier valid?
Documentation for this format
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Foundation.Terminology"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 1
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "anonymous"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "fhir"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/NamingSystem",
"version" : "4.0.1",
"name" : "NamingSystem",
"status" : "draft",
"date" : "2019-11-01T09:29:23+11:00",
"publisher" : "Health Level Seven International (FHIR Infrastructure)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/fiwg/index.cfm"
}]
}],
"description" : "A curated namespace that issues unique symbols within that namespace for the identification of concepts, people, devices, etc. Represents a \"System\" used within the Identifier and Coding data types.",
"fhirVersion" : "4.0.1",
"mapping" : [{
"identity" : "v2",
"uri" : "http://hl7.org/v2",
"name" : "HL7 v2 Mapping"
},
{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
},
{
"identity" : "workflow",
"uri" : "http://hl7.org/fhir/workflow",
"name" : "Workflow Pattern"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/fivews",
"name" : "FiveWs Pattern Mapping"
}],
"kind" : "resource",
"abstract" : false,
"type" : "NamingSystem",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"_baseDefinition" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-codegen-super",
"valueString" : "MetadataResource"
}]
},
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "NamingSystem",
"path" : "NamingSystem",
"short" : "System of unique identification",
"definition" : "A curated namespace that issues unique symbols within that namespace for the identification of concepts, people, devices, etc. Represents a \"System\" used within the Identifier and Coding data types.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "NamingSystem",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "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",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.`div`.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "nsd-0",
"severity" : "warning",
"human" : "Name should be usable as an identifier for the module by machine processing applications such as code generation",
"expression" : "name.matches('[A-Z]([A-Za-z0-9_]){0,254}')",
"xpath" : "not(exists(f:name/@value)) or matches(f:name/@value, '[A-Z]([A-Za-z0-9_]){0,254}')"
},
{
"key" : "nsd-1",
"severity" : "error",
"human" : "Root systems cannot have uuid identifiers",
"expression" : "kind != 'root' or uniqueId.all(type != 'uuid')",
"xpath" : "not(f:kind/@value='root' and f:uniqueId/f:type/@value='uuid')"
},
{
"key" : "nsd-2",
"severity" : "error",
"human" : "Can't have more than one preferred identifier for a type",
"expression" : "uniqueId.where(preferred = true).select(type).isDistinct()",
"xpath" : "not(exists(for $type in distinct-values(f:uniqueId/f:type/@value) return if (count(f:uniqueId[f:type/@value=$type and f:preferred/@value=true()])>1) then $type else ()))"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "v2",
"map" : "N/A"
},
{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "NamingSystem.id",
"path" : "NamingSystem.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "NamingSystem.meta",
"path" : "NamingSystem.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "NamingSystem.implicitRules",
"path" : "NamingSystem.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "NamingSystem.language",
"path" : "NamingSystem.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "NamingSystem.text",
"path" : "NamingSystem.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "NamingSystem.contained",
"path" : "NamingSystem.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "NamingSystem.extension",
"path" : "NamingSystem.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "NamingSystem.modifierExtension",
"path" : "NamingSystem.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "NamingSystem.name",
"path" : "NamingSystem.name",
"short" : "Name for this naming system (computer friendly)",
"definition" : "A natural language name identifying the naming system. This name should be usable as an identifier for the module by machine processing applications such as code generation.",
"comment" : "The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.The\"symbolic name\" for an OID would be captured as an extension.",
"requirements" : "Support human navigation and code generation.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "NamingSystem.name",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"condition" : ["inv-0"],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "NamingSystem.status",
"path" : "NamingSystem.status",
"short" : "draft | active | retired | unknown",
"definition" : "The status of this naming system. Enables tracking the life-cycle of the content.",
"comment" : "Allows filtering of naming systems that are appropriate for use versus not.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "NamingSystem.status",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This is labeled as \"Is Modifier\" because applications should not use a retired {{title}} without due consideration",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "PublicationStatus"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "The lifecycle status of an artifact.",
"valueSet" : "http://hl7.org/fhir/ValueSet/publication-status|4.0.1"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.status"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
}]
},
{
"id" : "NamingSystem.kind",
"path" : "NamingSystem.kind",
"short" : "codesystem | identifier | root",
"definition" : "Indicates the purpose for the naming system - what kinds of things does it make unique?",
"min" : 1,
"max" : "1",
"base" : {
"path" : "NamingSystem.kind",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "NamingSystemType"
}],
"strength" : "required",
"description" : "Identifies the purpose of the naming system.",
"valueSet" : "http://hl7.org/fhir/ValueSet/namingsystem-type|4.0.1"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.class"
}]
},
{
"id" : "NamingSystem.date",
"path" : "NamingSystem.date",
"short" : "Date last changed",
"definition" : "The date (and optionally time) when the naming system was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the naming system changes.",
"comment" : "Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the naming system. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.",
"alias" : ["Revision Date"],
"min" : 1,
"max" : "1",
"base" : {
"path" : "NamingSystem.date",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.date"
},
{
"identity" : "w5",
"map" : "FiveWs.recorded"
}]
},
{
"id" : "NamingSystem.publisher",
"path" : "NamingSystem.publisher",
"short" : "Name of the publisher (organization or individual)",
"definition" : "The name of the organization or individual that published the naming system.",
"comment" : "Usually an organization but may be an individual. The publisher (or steward) of the naming system is the organization or individual primarily responsible for the maintenance and upkeep of the naming system. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the naming system. This item SHOULD be populated unless the information is available from context.",
"requirements" : "Helps establish the \"authority/credibility\" of the naming system. May also allow for contact.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "NamingSystem.publisher",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.publisher"
},
{
"identity" : "w5",
"map" : "FiveWs.witness"
}]
},
{
"id" : "NamingSystem.contact",
"path" : "NamingSystem.contact",
"short" : "Contact details for the publisher",
"definition" : "Contact details to assist a user in finding and communicating with the publisher.",
"comment" : "May be a web site, an email address, a telephone number, etc.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "NamingSystem.contact",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "ContactDetail"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.contact"
}]
},
{
"id" : "NamingSystem.responsible",
"path" : "NamingSystem.responsible",
"short" : "Who maintains system namespace?",
"definition" : "The name of the organization that is responsible for issuing identifiers or codes for this namespace and ensuring their non-collision.",
"comment" : "This is the primary organization. Responsibility for some aspects of a namespace may be delegated.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "NamingSystem.responsible",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.witness"
}]
},
{
"id" : "NamingSystem.type",
"path" : "NamingSystem.type",
"short" : "e.g. driver, provider, patient, bank etc.",
"definition" : "Categorizes a naming system for easier search by grouping related naming systems.",
"comment" : "This will most commonly be used for identifier namespaces, but categories could potentially be useful for code systems and authorities as well.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "NamingSystem.type",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "IdentifierType"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "extensible",
"description" : "A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.",
"valueSet" : "http://hl7.org/fhir/ValueSet/identifier-type"
}
},
{
"id" : "NamingSystem.description",
"path" : "NamingSystem.description",
"short" : "Natural language description of the naming system",
"definition" : "A free text natural language description of the naming system from a consumer's perspective. Details about what the namespace identifies including scope, granularity, version labeling, etc.",
"comment" : "This description can be used to capture details such as why the naming system was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the naming system as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the naming system is presumed to be the predominant language in the place the naming system was created).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "NamingSystem.description",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "markdown"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.description"
}]
},
{
"id" : "NamingSystem.useContext",
"path" : "NamingSystem.useContext",
"short" : "The context that the content is intended to support",
"definition" : "The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate naming system instances.",
"comment" : "When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.",
"requirements" : "Assist in searching for appropriate content.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "NamingSystem.useContext",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "UsageContext"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.useContext"
}]
},
{
"id" : "NamingSystem.jurisdiction",
"path" : "NamingSystem.jurisdiction",
"short" : "Intended jurisdiction for naming system (if applicable)",
"definition" : "A legal or geographic region in which the naming system is intended to be used.",
"comment" : "It may be possible for the naming system to be used in jurisdictions other than those for which it was originally designed or intended.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "NamingSystem.jurisdiction",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Jurisdiction"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "extensible",
"description" : "Countries and regions within which this artifact is targeted for use.",
"valueSet" : "http://hl7.org/fhir/ValueSet/jurisdiction"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.jurisdiction"
}]
},
{
"id" : "NamingSystem.usage",
"path" : "NamingSystem.usage",
"short" : "How/where is it used",
"definition" : "Provides guidance on the use of the namespace, including the handling of formatting characters, use of upper vs. lower case, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "NamingSystem.usage",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "NamingSystem.uniqueId",
"path" : "NamingSystem.uniqueId",
"short" : "Unique identifiers used for system",
"definition" : "Indicates how the system may be identified when referenced in electronic exchange.",
"comment" : "Multiple identifiers may exist, either due to duplicate registration, regional rules, needs of different communication technologies, etc.",
"min" : 1,
"max" : "*",
"base" : {
"path" : "NamingSystem.uniqueId",
"min" : 1,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "NamingSystem.uniqueId.id",
"path" : "NamingSystem.uniqueId.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "NamingSystem.uniqueId.extension",
"path" : "NamingSystem.uniqueId.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "NamingSystem.uniqueId.modifierExtension",
"path" : "NamingSystem.uniqueId.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "NamingSystem.uniqueId.type",
"path" : "NamingSystem.uniqueId.type",
"short" : "oid | uuid | uri | other",
"definition" : "Identifies the unique identifier scheme used for this particular identifier.",
"comment" : "Different identifier types may be used in different types of communications (OIDs for v3, URIs for FHIR, etc.). Other includes RUIDs from v3, standard v2 code name strings, etc.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "NamingSystem.uniqueId.type",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "NamingSystemIdentifierType"
}],
"strength" : "required",
"description" : "Identifies the style of unique identifier used to identify a namespace.",
"valueSet" : "http://hl7.org/fhir/ValueSet/namingsystem-identifier-type|4.0.1"
}
},
{
"id" : "NamingSystem.uniqueId.value",
"path" : "NamingSystem.uniqueId.value",
"short" : "The unique identifier",
"definition" : "The string that should be sent over the wire to identify the code system or identifier system.",
"comment" : "If the value is a URI intended for use as FHIR system identifier, the URI should not contain \"\\\" or \"?\" or \",\" since this makes escaping very difficult.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "NamingSystem.uniqueId.value",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.identifier"
}]
},
{
"id" : "NamingSystem.uniqueId.preferred",
"path" : "NamingSystem.uniqueId.preferred",
"short" : "Is this the id that should be used for this type",
"definition" : "Indicates whether this identifier is the \"preferred\" identifier of this type.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "NamingSystem.uniqueId.preferred",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"meaningWhenMissing" : "If there are multiple ids, and one is labeled \"preferred\", then the assumption is that the others are not preferred. In the absence of any id marked as preferred, no inference can be drawn",
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "NamingSystem.uniqueId.comment",
"path" : "NamingSystem.uniqueId.comment",
"short" : "Notes about identifier usage",
"definition" : "Notes about the past or intended usage of this identifier.",
"comment" : "e.g. \"must be used in Germany\" or \"was initially published in error with this value\".",
"min" : 0,
"max" : "1",
"base" : {
"path" : "NamingSystem.uniqueId.comment",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "NamingSystem.uniqueId.period",
"path" : "NamingSystem.uniqueId.period",
"short" : "When is identifier valid?",
"definition" : "Identifies the period of time over which this identifier is considered appropriate to refer to the naming system. Outside of this window, the identifier might be non-deterministic.",
"comment" : "Within a registry, a given identifier should only be \"active\" for a single namespace at a time. (Ideally, an identifier should only ever be associated with a single namespace across all time).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "NamingSystem.uniqueId.period",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Period"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
}]
},
"differential" : {
"element" : [{
"id" : "NamingSystem",
"path" : "NamingSystem",
"short" : "System of unique identification",
"definition" : "A curated namespace that issues unique symbols within that namespace for the identification of concepts, people, devices, etc. Represents a \"System\" used within the Identifier and Coding data types.",
"min" : 0,
"max" : "*",
"constraint" : [{
"key" : "nsd-1",
"severity" : "error",
"human" : "Root systems cannot have uuid identifiers",
"expression" : "kind != 'root' or uniqueId.all(type != 'uuid')",
"xpath" : "not(f:kind/@value='root' and f:uniqueId/f:type/@value='uuid')"
},
{
"key" : "nsd-0",
"severity" : "warning",
"human" : "Name should be usable as an identifier for the module by machine processing applications such as code generation",
"expression" : "name.matches('[A-Z]([A-Za-z0-9_]){0,254}')",
"xpath" : "not(exists(f:name/@value)) or matches(f:name/@value, '[A-Z]([A-Za-z0-9_]){0,254}')"
},
{
"key" : "nsd-2",
"severity" : "error",
"human" : "Can't have more than one preferred identifier for a type",
"expression" : "uniqueId.where(preferred = true).select(type).isDistinct()",
"xpath" : "not(exists(for $type in distinct-values(f:uniqueId/f:type/@value) return if (count(f:uniqueId[f:type/@value=$type and f:preferred/@value=true()])>1) then $type else ()))"
}],
"mapping" : [{
"identity" : "v2",
"map" : "N/A"
},
{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "NamingSystem.name",
"path" : "NamingSystem.name",
"short" : "Name for this naming system (computer friendly)",
"definition" : "A natural language name identifying the naming system. This name should be usable as an identifier for the module by machine processing applications such as code generation.",
"comment" : "The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.The\"symbolic name\" for an OID would be captured as an extension.",
"requirements" : "Support human navigation and code generation.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "string"
}],
"condition" : ["inv-0"],
"isSummary" : true
},
{
"id" : "NamingSystem.status",
"path" : "NamingSystem.status",
"short" : "draft | active | retired | unknown",
"definition" : "The status of this naming system. Enables tracking the life-cycle of the content.",
"comment" : "Allows filtering of naming systems that are appropriate for use versus not.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isModifier" : true,
"isModifierReason" : "This is labeled as \"Is Modifier\" because applications should not use a retired {{title}} without due consideration",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "PublicationStatus"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "The lifecycle status of an artifact.",
"valueSet" : "http://hl7.org/fhir/ValueSet/publication-status|4.0.1"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.status"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
}]
},
{
"id" : "NamingSystem.kind",
"path" : "NamingSystem.kind",
"short" : "codesystem | identifier | root",
"definition" : "Indicates the purpose for the naming system - what kinds of things does it make unique?",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "NamingSystemType"
}],
"strength" : "required",
"description" : "Identifies the purpose of the naming system.",
"valueSet" : "http://hl7.org/fhir/ValueSet/namingsystem-type|4.0.1"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.class"
}]
},
{
"id" : "NamingSystem.date",
"path" : "NamingSystem.date",
"short" : "Date last changed",
"definition" : "The date (and optionally time) when the naming system was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the naming system changes.",
"comment" : "Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the naming system. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.",
"alias" : ["Revision Date"],
"min" : 1,
"max" : "1",
"type" : [{
"code" : "dateTime"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.date"
},
{
"identity" : "w5",
"map" : "FiveWs.recorded"
}]
},
{
"id" : "NamingSystem.publisher",
"path" : "NamingSystem.publisher",
"short" : "Name of the publisher (organization or individual)",
"definition" : "The name of the organization or individual that published the naming system.",
"comment" : "Usually an organization but may be an individual. The publisher (or steward) of the naming system is the organization or individual primarily responsible for the maintenance and upkeep of the naming system. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the naming system. This item SHOULD be populated unless the information is available from context.",
"requirements" : "Helps establish the \"authority/credibility\" of the naming system. May also allow for contact.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.publisher"
},
{
"identity" : "w5",
"map" : "FiveWs.witness"
}]
},
{
"id" : "NamingSystem.contact",
"path" : "NamingSystem.contact",
"short" : "Contact details for the publisher",
"definition" : "Contact details to assist a user in finding and communicating with the publisher.",
"comment" : "May be a web site, an email address, a telephone number, etc.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "ContactDetail"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.contact"
}]
},
{
"id" : "NamingSystem.responsible",
"path" : "NamingSystem.responsible",
"short" : "Who maintains system namespace?",
"definition" : "The name of the organization that is responsible for issuing identifiers or codes for this namespace and ensuring their non-collision.",
"comment" : "This is the primary organization. Responsibility for some aspects of a namespace may be delegated.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.witness"
}]
},
{
"id" : "NamingSystem.type",
"path" : "NamingSystem.type",
"short" : "e.g. driver, provider, patient, bank etc.",
"definition" : "Categorizes a naming system for easier search by grouping related naming systems.",
"comment" : "This will most commonly be used for identifier namespaces, but categories could potentially be useful for code systems and authorities as well.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "IdentifierType"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "extensible",
"description" : "A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.",
"valueSet" : "http://hl7.org/fhir/ValueSet/identifier-type"
}
},
{
"id" : "NamingSystem.description",
"path" : "NamingSystem.description",
"short" : "Natural language description of the naming system",
"definition" : "A free text natural language description of the naming system from a consumer's perspective. Details about what the namespace identifies including scope, granularity, version labeling, etc.",
"comment" : "This description can be used to capture details such as why the naming system was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the naming system as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the naming system is presumed to be the predominant language in the place the naming system was created).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "markdown"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.description"
}]
},
{
"id" : "NamingSystem.useContext",
"path" : "NamingSystem.useContext",
"short" : "The context that the content is intended to support",
"definition" : "The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate naming system instances.",
"comment" : "When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.",
"requirements" : "Assist in searching for appropriate content.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "UsageContext"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.useContext"
}]
},
{
"id" : "NamingSystem.jurisdiction",
"path" : "NamingSystem.jurisdiction",
"short" : "Intended jurisdiction for naming system (if applicable)",
"definition" : "A legal or geographic region in which the naming system is intended to be used.",
"comment" : "It may be possible for the naming system to be used in jurisdictions other than those for which it was originally designed or intended.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Jurisdiction"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "extensible",
"description" : "Countries and regions within which this artifact is targeted for use.",
"valueSet" : "http://hl7.org/fhir/ValueSet/jurisdiction"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.jurisdiction"
}]
},
{
"id" : "NamingSystem.usage",
"path" : "NamingSystem.usage",
"short" : "How/where is it used",
"definition" : "Provides guidance on the use of the namespace, including the handling of formatting characters, use of upper vs. lower case, etc.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}]
},
{
"id" : "NamingSystem.uniqueId",
"path" : "NamingSystem.uniqueId",
"short" : "Unique identifiers used for system",
"definition" : "Indicates how the system may be identified when referenced in electronic exchange.",
"comment" : "Multiple identifiers may exist, either due to duplicate registration, regional rules, needs of different communication technologies, etc.",
"min" : 1,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"isSummary" : true
},
{
"id" : "NamingSystem.uniqueId.type",
"path" : "NamingSystem.uniqueId.type",
"short" : "oid | uuid | uri | other",
"definition" : "Identifies the unique identifier scheme used for this particular identifier.",
"comment" : "Different identifier types may be used in different types of communications (OIDs for v3, URIs for FHIR, etc.). Other includes RUIDs from v3, standard v2 code name strings, etc.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "NamingSystemIdentifierType"
}],
"strength" : "required",
"description" : "Identifies the style of unique identifier used to identify a namespace.",
"valueSet" : "http://hl7.org/fhir/ValueSet/namingsystem-identifier-type|4.0.1"
}
},
{
"id" : "NamingSystem.uniqueId.value",
"path" : "NamingSystem.uniqueId.value",
"short" : "The unique identifier",
"definition" : "The string that should be sent over the wire to identify the code system or identifier system.",
"comment" : "If the value is a URI intended for use as FHIR system identifier, the URI should not contain \"\\\" or \"?\" or \",\" since this makes escaping very difficult.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.identifier"
}]
},
{
"id" : "NamingSystem.uniqueId.preferred",
"path" : "NamingSystem.uniqueId.preferred",
"short" : "Is this the id that should be used for this type",
"definition" : "Indicates whether this identifier is the \"preferred\" identifier of this type.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "boolean"
}],
"meaningWhenMissing" : "If there are multiple ids, and one is labeled \"preferred\", then the assumption is that the others are not preferred. In the absence of any id marked as preferred, no inference can be drawn"
},
{
"id" : "NamingSystem.uniqueId.comment",
"path" : "NamingSystem.uniqueId.comment",
"short" : "Notes about identifier usage",
"definition" : "Notes about the past or intended usage of this identifier.",
"comment" : "e.g. \"must be used in Germany\" or \"was initially published in error with this value\".",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}]
},
{
"id" : "NamingSystem.uniqueId.period",
"path" : "NamingSystem.uniqueId.period",
"short" : "When is identifier valid?",
"definition" : "Identifies the period of time over which this identifier is considered appropriate to refer to the naming system. Outside of this window, the identifier might be non-deterministic.",
"comment" : "Within a registry, a given identifier should only be \"active\" for a single namespace at a time. (Ideally, an identifier should only ever be associated with a single namespace across all time).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Period"
}]
}]
}
}
},
{
"fullUrl" : "http://hl7.org/fhir/StructureDefinition/NutritionOrder",
"resource" : {
"resourceType" : "StructureDefinition",
"id" : "NutritionOrder",
"meta" : {
"lastUpdated" : "2019-11-01T09:29:23.356+11:00"
},
"text" : {
"status" : "generated",
"div" : "Name Flags Card. Type Description & Constraints NutritionOrder ITU 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 identifier 0..* Identifier Identifiers assigned to this order
instantiatesCanonical Σ 0..* canonical(ActivityDefinition | PlanDefinition) Instantiates FHIR protocol or definition
instantiatesUri Σ 0..* uri Instantiates external protocol or definition
instantiates 0..* uri Instantiates protocol or definition
status ?!Σ 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
RequestStatus (Required) intent ?!Σ 1..1 code proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
RequestIntent (Required) patient Σ 1..1 Reference(Patient) The person who requires the diet, formula or nutritional supplement encounter 0..1 Reference(Encounter) The encounter associated with this nutrition order dateTime Σ 1..1 dateTime Date and time the nutrition order was requested orderer Σ 0..1 Reference(Practitioner | PractitionerRole) Who ordered the diet, formula or nutritional supplement allergyIntolerance 0..* Reference(AllergyIntolerance) List of the patient's food and nutrition-related allergies and intolerances
foodPreferenceModifier 0..* CodeableConcept Order-specific modifier about the type of food that should be given
Diet (Example)
excludeFoodModifier 0..* CodeableConcept Order-specific modifier about the type of food that should not be given
Food Type Codes (Example)
oralDiet I 0..1 BackboneElement Oral diet components type Σ 0..* CodeableConcept Type of oral diet or diet restrictions that describe what can be consumed orally
Diet Codes (Example)
schedule 0..* Timing Scheduled frequency of diet
nutrient 0..* BackboneElement Required nutrient modifications
modifier 0..1 CodeableConcept Type of nutrient that is being modified
Nutrient Modifier Codes (Example) amount 0..1 SimpleQuantity Quantity of the specified nutrient texture 0..* BackboneElement Required texture modifications
modifier 0..1 CodeableConcept Code to indicate how to alter the texture of the foods, e.g. pureed
Texture Modifier Codes (Example) foodType 0..1 CodeableConcept Concepts that are used to identify an entity that is ingested for nutritional purposes
Texture Modified Food Type Codes (Example) fluidConsistencyType 0..* CodeableConcept The required consistency of fluids and liquids provided to the patient
Fluid Consistency Type Codes (Example)
instruction Σ 0..1 string Instructions or additional information about the oral diet supplement I 0..* BackboneElement Supplement components
type Σ 0..1 CodeableConcept Type of supplement product requested
Supplement Type Codes (Example) productName 0..1 string Product or brand name of the nutritional supplement schedule 0..* Timing Scheduled frequency of supplement
quantity 0..1 SimpleQuantity Amount of the nutritional supplement instruction Σ 0..1 string Instructions or additional information about the oral supplement enteralFormula I 0..1 BackboneElement Enteral formula components baseFormulaType Σ 0..1 CodeableConcept Type of enteral or infant formula
Enteral Formula Type Codes (Example) baseFormulaProductName 0..1 string Product or brand name of the enteral or infant formula additiveType 0..1 CodeableConcept Type of modular component to add to the feeding
Enteral Formula Additive Type Code (Example) additiveProductName 0..1 string Product or brand name of the modular additive caloricDensity 0..1 SimpleQuantity Amount of energy per specified volume that is required routeofAdministration 0..1 CodeableConcept How the formula should enter the patient's gastrointestinal tract
Enteral Route Codes (Extensible) administration 0..* BackboneElement Formula feeding instruction as structured data
schedule 0..1 Timing Scheduled frequency of enteral feeding quantity 0..1 SimpleQuantity The volume of formula to provide rate[x] 0..1 Speed with which the formula is provided per period of time rateQuantity SimpleQuantity rateRatio Ratio maxVolumeToDeliver 0..1 SimpleQuantity Upper limit on formula volume per unit of time administrationInstruction Σ 0..1 string Formula feeding instructions expressed as text note 0..* Annotation Comments
Documentation for this format
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Clinical.Care Provision"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 2
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "patient"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "oo"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/NutritionOrder",
"version" : "4.0.1",
"name" : "NutritionOrder",
"status" : "draft",
"date" : "2019-11-01T09:29:23+11:00",
"publisher" : "Health Level Seven International (Orders and Observations)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/orders/index.cfm"
}]
}],
"description" : "A request to supply a diet, formula feeding (enteral) or oral nutritional supplement to a patient/resident.",
"fhirVersion" : "4.0.1",
"mapping" : [{
"identity" : "workflow",
"uri" : "http://hl7.org/fhir/workflow",
"name" : "Workflow Pattern"
},
{
"identity" : "v2",
"uri" : "http://hl7.org/v2",
"name" : "HL7 v2 Mapping"
},
{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/fivews",
"name" : "FiveWs Pattern Mapping"
}],
"kind" : "resource",
"abstract" : false,
"type" : "NutritionOrder",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "NutritionOrder",
"path" : "NutritionOrder",
"short" : "Diet, formula or nutritional supplement request",
"definition" : "A request to supply a diet, formula feeding (enteral) or oral nutritional supplement to a patient/resident.",
"comment" : "Referenced by an Order Request (workflow).",
"alias" : ["Nutrition Order",
"Diet Order",
"Diet",
"Nutritional Supplement",
"Enteral Nutrition"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "NutritionOrder",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "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",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.`div`.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "nor-1",
"severity" : "warning",
"human" : "Nutrition Order SHALL contain either Oral Diet , Supplement, or Enteral Formula class",
"expression" : "oralDiet.exists() or supplement.exists() or enteralFormula.exists()",
"xpath" : "exists(f:oralDiet) or exists(f:supplement) or exists(f:enteralFormula)"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "workflow",
"map" : "Request"
},
{
"identity" : "v2",
"map" : "ORC / ODS"
},
{
"identity" : "rim",
"map" : "SupplyRequest"
}]
},
{
"id" : "NutritionOrder.id",
"path" : "NutritionOrder.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "NutritionOrder.meta",
"path" : "NutritionOrder.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "NutritionOrder.implicitRules",
"path" : "NutritionOrder.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "NutritionOrder.language",
"path" : "NutritionOrder.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "NutritionOrder.text",
"path" : "NutritionOrder.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "NutritionOrder.contained",
"path" : "NutritionOrder.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "NutritionOrder.extension",
"path" : "NutritionOrder.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "NutritionOrder.modifierExtension",
"path" : "NutritionOrder.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "NutritionOrder.identifier",
"path" : "NutritionOrder.identifier",
"short" : "Identifiers assigned to this order",
"definition" : "Identifiers assigned to this order by the order sender or by the order receiver.",
"comment" : "The Identifier.type element can be to indicate filler vs. placer if needed. This is explained in further detail [here](servicerequest.html#notes).",
"min" : 0,
"max" : "*",
"base" : {
"path" : "NutritionOrder.identifier",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Identifier"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.identifier"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "v2",
"map" : "ORC-2/ORC-3"
},
{
"identity" : "rim",
"map" : ".id"
}]
},
{
"id" : "NutritionOrder.instantiatesCanonical",
"path" : "NutritionOrder.instantiatesCanonical",
"short" : "Instantiates FHIR protocol or definition",
"definition" : "The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this NutritionOrder.",
"comment" : "Note: This is a business identifier, not a resource identifier (see [discussion](resource.html#identifiers)). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "NutritionOrder.instantiatesCanonical",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ActivityDefinition",
"http://hl7.org/fhir/StructureDefinition/PlanDefinition"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.instantiatesCanonical"
},
{
"identity" : "v2",
"map" : "Varies by domain"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=DEFN].target"
}]
},
{
"id" : "NutritionOrder.instantiatesUri",
"path" : "NutritionOrder.instantiatesUri",
"short" : "Instantiates external protocol or definition",
"definition" : "The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this NutritionOrder.",
"comment" : "This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "NutritionOrder.instantiatesUri",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.instantiatesUri"
},
{
"identity" : "v2",
"map" : "Varies by domain"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=DEFN].target"
}]
},
{
"id" : "NutritionOrder.instantiates",
"path" : "NutritionOrder.instantiates",
"short" : "Instantiates protocol or definition",
"definition" : "The URL pointing to a protocol, guideline, orderset or other definition that is adhered to in whole or in part by this NutritionOrder.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "NutritionOrder.instantiates",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.instantiates"
},
{
"identity" : "v2",
"map" : "Varies by domain"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=DEFN].target"
}]
},
{
"id" : "NutritionOrder.status",
"path" : "NutritionOrder.status",
"short" : "draft | active | on-hold | revoked | completed | entered-in-error | unknown",
"definition" : "The workflow status of the nutrition order/request.",
"comment" : "Typically the system placing the order sets the status to \"requested\". Thereafter, the order is maintained by the receiver that updates the status as the request is handled. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "NutritionOrder.status",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "NutritionOrderStatus"
}],
"strength" : "required",
"description" : "Codes identifying the lifecycle stage of the nutrition order.",
"valueSet" : "http://hl7.org/fhir/ValueSet/request-status|4.0.1"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.status"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
},
{
"identity" : "v2",
"map" : "ORC-1"
},
{
"identity" : "rim",
"map" : ".statusCode"
}]
},
{
"id" : "NutritionOrder.intent",
"path" : "NutritionOrder.intent",
"short" : "proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option",
"definition" : "Indicates the level of authority/intentionality associated with the NutrionOrder and where the request fits into the workflow chain.",
"comment" : "When resources map to this element, they are free to define as many codes as necessary to cover their space and will map to \"proposal, plan or order\". Can have multiple codes that map to one of these. E.g. \"original order\", \"encoded order\", \"reflex order\" would all map to \"order\". Expectation is that the set of codes is mutually exclusive or a strict all-encompassing hierarchy.",
"requirements" : "Proposals/recommendations, plans and orders all use the same structure and can exist in the same fulfillment chain.",
"alias" : ["category"],
"min" : 1,
"max" : "1",
"base" : {
"path" : "NutritionOrder.intent",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element changes the interpretation of all descriptive attributes. For example \"the time the request is recommended to occur\" vs. \"the time the request is authorized to occur\" or \"who is recommended to perform the request\" vs. \"who is authorized to perform the request",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "NutritiionOrderIntent"
}],
"strength" : "required",
"description" : "Codes indicating the degree of authority/intentionality associated with a nutrition order.",
"valueSet" : "http://hl7.org/fhir/ValueSet/request-intent|4.0.1"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.intent"
},
{
"identity" : "w5",
"map" : "FiveWs.class"
},
{
"identity" : "v2",
"map" : "N/A"
},
{
"identity" : "rim",
"map" : ".moodCode (nuances beyond PRP/PLAN/RQO would need to be elsewhere)"
}]
},
{
"id" : "NutritionOrder.patient",
"path" : "NutritionOrder.patient",
"short" : "The person who requires the diet, formula or nutritional supplement",
"definition" : "The person (patient) who needs the nutrition order for an oral diet, nutritional supplement and/or enteral or formula feeding.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "NutritionOrder.patient",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.subject"
},
{
"identity" : "w5",
"map" : "FiveWs.subject[x]"
},
{
"identity" : "v2",
"map" : "PID"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=SBJ].role"
},
{
"identity" : "w5",
"map" : "FiveWs.subject"
}]
},
{
"id" : "NutritionOrder.encounter",
"path" : "NutritionOrder.encounter",
"short" : "The encounter associated with this nutrition order",
"definition" : "An encounter that provides additional information about the healthcare context in which this request is made.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "NutritionOrder.encounter",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Encounter"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.encounter"
},
{
"identity" : "w5",
"map" : "FiveWs.context"
},
{
"identity" : "v2",
"map" : "PV1"
},
{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN]"
}]
},
{
"id" : "NutritionOrder.dateTime",
"path" : "NutritionOrder.dateTime",
"short" : "Date and time the nutrition order was requested",
"definition" : "The date and time that this nutrition order was requested.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "NutritionOrder.dateTime",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.authoredOn"
},
{
"identity" : "w5",
"map" : "FiveWs.recorded"
},
{
"identity" : "v2",
"map" : "ORC-9"
},
{
"identity" : "rim",
"map" : "author.time"
}]
},
{
"id" : "NutritionOrder.orderer",
"path" : "NutritionOrder.orderer",
"short" : "Who ordered the diet, formula or nutritional supplement",
"definition" : "The practitioner that holds legal responsibility for ordering the diet, nutritional supplement, or formula feedings.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "NutritionOrder.orderer",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.requester"
},
{
"identity" : "w5",
"map" : "FiveWs.author"
},
{
"identity" : "v2",
"map" : "ORC-12"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=AUT].role"
}]
},
{
"id" : "NutritionOrder.allergyIntolerance",
"path" : "NutritionOrder.allergyIntolerance",
"short" : "List of the patient's food and nutrition-related allergies and intolerances",
"definition" : "A link to a record of allergies or intolerances which should be included in the nutrition order.",
"comment" : "Information on a patient's food allergies and intolerances to inform healthcare personnel about the type of foods that the patient shouldn't receive or consume.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "NutritionOrder.allergyIntolerance",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/AllergyIntolerance"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=RSON].target[classCode=OBS, moodCode=EVN]"
}]
},
{
"id" : "NutritionOrder.foodPreferenceModifier",
"path" : "NutritionOrder.foodPreferenceModifier",
"short" : "Order-specific modifier about the type of food that should be given",
"definition" : "This modifier is used to convey order-specific modifiers about the type of food that should be given. These can be derived from patient allergies, intolerances, or preferences such as Halal, Vegan or Kosher. This modifier applies to the entire nutrition order inclusive of the oral diet, nutritional supplements and enteral formula feedings.",
"comment" : "Information on a patient's food preferences that inform healthcare personnel about the food that the patient should receive or consume.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "NutritionOrder.foodPreferenceModifier",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "PatientDiet"
}],
"strength" : "example",
"description" : "Medical, cultural or ethical food preferences to help with catering requirements.",
"valueSet" : "http://hl7.org/fhir/ValueSet/encounter-diet"
},
"mapping" : [{
"identity" : "v2",
"map" : "ODS-1 Value = \"P\",ODS-3"
},
{
"identity" : "rim",
"map" : ".outboundRelationship [typeCode =COMP], target [classCode=PROC, moodCode=EVN, code=NutritionModificationType]"
}]
},
{
"id" : "NutritionOrder.excludeFoodModifier",
"path" : "NutritionOrder.excludeFoodModifier",
"short" : "Order-specific modifier about the type of food that should not be given",
"definition" : "This modifier is used to convey Order-specific modifier about the type of oral food or oral fluids that should not be given. These can be derived from patient allergies, intolerances, or preferences such as No Red Meat, No Soy or No Wheat or Gluten-Free. While it should not be necessary to repeat allergy or intolerance information captured in the referenced AllergyIntolerance resource in the excludeFoodModifier, this element may be used to convey additional specificity related to foods that should be eliminated from the patient’s diet for any reason. This modifier applies to the entire nutrition order inclusive of the oral diet, nutritional supplements and enteral formula feedings.",
"comment" : "Information on a patient's food allergies, intolerances and preferences to inform healthcare personnel about the type of foods that the patient shouldn't receive or consume.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "NutritionOrder.excludeFoodModifier",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "FoodType"
}],
"strength" : "example",
"description" : "Codes used to indicate the type of food that should NOT be given to the patient.",
"valueSet" : "http://hl7.org/fhir/ValueSet/food-type"
},
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "NutritionOrder.oralDiet",
"path" : "NutritionOrder.oralDiet",
"short" : "Oral diet components",
"definition" : "Diet given orally in contrast to enteral (tube) feeding.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "NutritionOrder.oralDiet",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "BackboneElement"
}],
"condition" : ["nor-1"],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "ODS-1 Value = \"D\""
},
{
"identity" : "rim",
"map" : "oralDiet .outboundRelationship [typeCode =COMP], target [classCode=SPLY, moodCode=RQO, code=OralDietSupplyType]"
}]
},
{
"id" : "NutritionOrder.oralDiet.id",
"path" : "NutritionOrder.oralDiet.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "NutritionOrder.oralDiet.extension",
"path" : "NutritionOrder.oralDiet.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "NutritionOrder.oralDiet.modifierExtension",
"path" : "NutritionOrder.oralDiet.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "NutritionOrder.oralDiet.type",
"path" : "NutritionOrder.oralDiet.type",
"short" : "Type of oral diet or diet restrictions that describe what can be consumed orally",
"definition" : "The kind of diet or dietary restriction such as fiber restricted diet or diabetic diet.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "NutritionOrder.oralDiet.type",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "OralDiet"
}],
"strength" : "example",
"description" : "Codes used to indicate the type of diet being ordered for a patient.",
"valueSet" : "http://hl7.org/fhir/ValueSet/diet-type"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.code"
},
{
"identity" : "w5",
"map" : "FiveWs.what[x]"
},
{
"identity" : "v2",
"map" : "ODS-3"
},
{
"identity" : "rim",
"map" : ".code"
}]
},
{
"id" : "NutritionOrder.oralDiet.schedule",
"path" : "NutritionOrder.oralDiet.schedule",
"short" : "Scheduled frequency of diet",
"definition" : "The time period and frequency at which the diet should be given. The diet should be given for the combination of all schedules if more than one schedule is present.",
"alias" : ["Frequency"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "NutritionOrder.oralDiet.schedule",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Timing"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.occurrence[x]"
},
{
"identity" : "v2",
"map" : "ODS-2, TQ1-7/8"
},
{
"identity" : "rim",
"map" : ".expectedUseTime"
}]
},
{
"id" : "NutritionOrder.oralDiet.nutrient",
"path" : "NutritionOrder.oralDiet.nutrient",
"short" : "Required nutrient modifications",
"definition" : "Class that defines the quantity and type of nutrient modifications (for example carbohydrate, fiber or sodium) required for the oral diet.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "NutritionOrder.oralDiet.nutrient",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "ODS-4"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=PRD].role[classCode=MANU], manufacturedFoodKind"
}]
},
{
"id" : "NutritionOrder.oralDiet.nutrient.id",
"path" : "NutritionOrder.oralDiet.nutrient.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "NutritionOrder.oralDiet.nutrient.extension",
"path" : "NutritionOrder.oralDiet.nutrient.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "NutritionOrder.oralDiet.nutrient.modifierExtension",
"path" : "NutritionOrder.oralDiet.nutrient.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "NutritionOrder.oralDiet.nutrient.modifier",
"path" : "NutritionOrder.oralDiet.nutrient.modifier",
"short" : "Type of nutrient that is being modified",
"definition" : "The nutrient that is being modified such as carbohydrate or sodium.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "NutritionOrder.oralDiet.nutrient.modifier",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "NutrientModifier"
}],
"strength" : "example",
"description" : "Codes for types of nutrients that are being modified such as carbohydrate or sodium.",
"valueSet" : "http://hl7.org/fhir/ValueSet/nutrient-code"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.code"
},
{
"identity" : "w5",
"map" : "FiveWs.what[x]"
},
{
"identity" : "v2",
"map" : "ODS-4"
},
{
"identity" : "rim",
"map" : ".code"
}]
},
{
"id" : "NutritionOrder.oralDiet.nutrient.amount",
"path" : "NutritionOrder.oralDiet.nutrient.amount",
"short" : "Quantity of the specified nutrient",
"definition" : "The quantity of the specified nutrient to include in diet.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "NutritionOrder.oralDiet.nutrient.amount",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Quantity",
"profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "ODS-4"
},
{
"identity" : "rim",
"map" : ".quantity"
}]
},
{
"id" : "NutritionOrder.oralDiet.texture",
"path" : "NutritionOrder.oralDiet.texture",
"short" : "Required texture modifications",
"definition" : "Class that describes any texture modifications required for the patient to safely consume various types of solid foods.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "NutritionOrder.oralDiet.texture",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "ODS-4"
},
{
"identity" : "rim",
"map" : ".inboundRelationship [typeCode =COMP], target [classCode=PROC, moodCode=EVN, code=DietTextureModificationType]"
}]
},
{
"id" : "NutritionOrder.oralDiet.texture.id",
"path" : "NutritionOrder.oralDiet.texture.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "NutritionOrder.oralDiet.texture.extension",
"path" : "NutritionOrder.oralDiet.texture.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "NutritionOrder.oralDiet.texture.modifierExtension",
"path" : "NutritionOrder.oralDiet.texture.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "NutritionOrder.oralDiet.texture.modifier",
"path" : "NutritionOrder.oralDiet.texture.modifier",
"short" : "Code to indicate how to alter the texture of the foods, e.g. pureed",
"definition" : "Any texture modifications (for solid foods) that should be made, e.g. easy to chew, chopped, ground, and pureed.",
"comment" : "Coupled with the foodType (Meat).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "NutritionOrder.oralDiet.texture.modifier",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "TextureModifier"
}],
"strength" : "example",
"description" : "Codes for food consistency types or texture modifications to apply to foods.",
"valueSet" : "http://hl7.org/fhir/ValueSet/texture-code"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.code"
},
{
"identity" : "v2",
"map" : "ODS-4"
},
{
"identity" : "rim",
"map" : ".code"
}]
},
{
"id" : "NutritionOrder.oralDiet.texture.foodType",
"path" : "NutritionOrder.oralDiet.texture.foodType",
"short" : "Concepts that are used to identify an entity that is ingested for nutritional purposes",
"definition" : "The food type(s) (e.g. meats, all foods) that the texture modification applies to. This could be all foods types.",
"comment" : "Coupled with the `texture.modifier`; could be (All Foods).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "NutritionOrder.oralDiet.texture.foodType",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "TextureModifiedFoodType"
}],
"strength" : "example",
"description" : "Codes for types of foods that are texture-modified.",
"valueSet" : "http://hl7.org/fhir/ValueSet/modified-foodtype"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.code"
},
{
"identity" : "v2",
"map" : "ODS-4"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=PRD].role[classCode=MANU], manufacturedFoodKind; .code"
}]
},
{
"id" : "NutritionOrder.oralDiet.fluidConsistencyType",
"path" : "NutritionOrder.oralDiet.fluidConsistencyType",
"short" : "The required consistency of fluids and liquids provided to the patient",
"definition" : "The required consistency (e.g. honey-thick, nectar-thick, thin, thickened.) of liquids or fluids served to the patient.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "NutritionOrder.oralDiet.fluidConsistencyType",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "FluidConsistencyType"
}],
"strength" : "example",
"description" : "Codes used to represent the consistency of fluids and liquids provided to the patient.",
"valueSet" : "http://hl7.org/fhir/ValueSet/consistency-type"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.code"
},
{
"identity" : "v2",
"map" : "ODS-4"
},
{
"identity" : "rim",
"map" : ".code (Not differentiated from dietTextureModificationType in HL7 v3)"
}]
},
{
"id" : "NutritionOrder.oralDiet.instruction",
"path" : "NutritionOrder.oralDiet.instruction",
"short" : "Instructions or additional information about the oral diet",
"definition" : "Free text or additional instructions or information pertaining to the oral diet.",
"comment" : "Free text dosage instructions can be used for cases where the instructions are too complex to code.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "NutritionOrder.oralDiet.instruction",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.supportingInfo"
},
{
"identity" : "v2",
"map" : "ODS-4"
},
{
"identity" : "rim",
"map" : ".text"
}]
},
{
"id" : "NutritionOrder.supplement",
"path" : "NutritionOrder.supplement",
"short" : "Supplement components",
"definition" : "Oral nutritional products given in order to add further nutritional value to the patient's diet.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "NutritionOrder.supplement",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"condition" : ["nor-1"],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "ODS-1 Value = \"P\""
},
{
"identity" : "rim",
"map" : ".outboundRelationship [typeCode =COMP], target [classCode=SPLY, moodCode=RQO, code=SUPPLEMENT]"
}]
},
{
"id" : "NutritionOrder.supplement.id",
"path" : "NutritionOrder.supplement.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "NutritionOrder.supplement.extension",
"path" : "NutritionOrder.supplement.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "NutritionOrder.supplement.modifierExtension",
"path" : "NutritionOrder.supplement.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "NutritionOrder.supplement.type",
"path" : "NutritionOrder.supplement.type",
"short" : "Type of supplement product requested",
"definition" : "The kind of nutritional supplement product required such as a high protein or pediatric clear liquid supplement.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "NutritionOrder.supplement.type",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SupplementType"
}],
"strength" : "example",
"description" : "Codes for nutritional supplements to be provided to the patient.",
"valueSet" : "http://hl7.org/fhir/ValueSet/supplement-type"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.code"
},
{
"identity" : "w5",
"map" : "FiveWs.what[x]"
},
{
"identity" : "v2",
"map" : "ODS-3"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=PRD].role[classCode=MANU], manufacturedFoodKind; .code (NutritionalSupplementType)"
}]
},
{
"id" : "NutritionOrder.supplement.productName",
"path" : "NutritionOrder.supplement.productName",
"short" : "Product or brand name of the nutritional supplement",
"definition" : "The product or brand name of the nutritional supplement such as \"Acme Protein Shake\".",
"min" : 0,
"max" : "1",
"base" : {
"path" : "NutritionOrder.supplement.productName",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "ODS-3"
},
{
"identity" : "rim",
"map" : ".id"
}]
},
{
"id" : "NutritionOrder.supplement.schedule",
"path" : "NutritionOrder.supplement.schedule",
"short" : "Scheduled frequency of supplement",
"definition" : "The time period and frequency at which the supplement(s) should be given. The supplement should be given for the combination of all schedules if more than one schedule is present.",
"alias" : ["Frequency"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "NutritionOrder.supplement.schedule",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Timing"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.occurrence[x]"
},
{
"identity" : "v2",
"map" : "ODS-2,TQ1-7/8"
},
{
"identity" : "rim",
"map" : ".effectiveTime"
}]
},
{
"id" : "NutritionOrder.supplement.quantity",
"path" : "NutritionOrder.supplement.quantity",
"short" : "Amount of the nutritional supplement",
"definition" : "The amount of the nutritional supplement to be given.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "NutritionOrder.supplement.quantity",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Quantity",
"profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "TQ1-2"
},
{
"identity" : "rim",
"map" : ".quantity"
}]
},
{
"id" : "NutritionOrder.supplement.instruction",
"path" : "NutritionOrder.supplement.instruction",
"short" : "Instructions or additional information about the oral supplement",
"definition" : "Free text or additional instructions or information pertaining to the oral supplement.",
"comment" : "Free text dosage instructions can be used for cases where the instructions are too complex to code.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "NutritionOrder.supplement.instruction",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.supportingInfo"
},
{
"identity" : "v2",
"map" : "ODS-4"
},
{
"identity" : "rim",
"map" : ".text"
}]
},
{
"id" : "NutritionOrder.enteralFormula",
"path" : "NutritionOrder.enteralFormula",
"short" : "Enteral formula components",
"definition" : "Feeding provided through the gastrointestinal tract via a tube, catheter, or stoma that delivers nutrition distal to the oral cavity.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "NutritionOrder.enteralFormula",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "BackboneElement"
}],
"condition" : ["nor-1"],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "ODS-1 Value coded for enteral"
},
{
"identity" : "rim",
"map" : ".outboundRelationship [typeCode =COMP], target [classCode=SPLY, moodCode=RQO, code=FORMULA]"
}]
},
{
"id" : "NutritionOrder.enteralFormula.id",
"path" : "NutritionOrder.enteralFormula.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "NutritionOrder.enteralFormula.extension",
"path" : "NutritionOrder.enteralFormula.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "NutritionOrder.enteralFormula.modifierExtension",
"path" : "NutritionOrder.enteralFormula.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "NutritionOrder.enteralFormula.baseFormulaType",
"path" : "NutritionOrder.enteralFormula.baseFormulaType",
"short" : "Type of enteral or infant formula",
"definition" : "The type of enteral or infant formula such as an adult standard formula with fiber or a soy-based infant formula.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "NutritionOrder.enteralFormula.baseFormulaType",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "EnteralFormulaType"
}],
"strength" : "example",
"description" : "Codes for type of enteral formula to be administered to patient.",
"valueSet" : "http://hl7.org/fhir/ValueSet/entformula-type"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.code"
},
{
"identity" : "w5",
"map" : "FiveWs.what[x]"
},
{
"identity" : "v2",
"map" : "ODS-3"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=PRD].role[classCode=MANU], manufacturedFoodKind; .code (NutritionalFormulaType)"
}]
},
{
"id" : "NutritionOrder.enteralFormula.baseFormulaProductName",
"path" : "NutritionOrder.enteralFormula.baseFormulaProductName",
"short" : "Product or brand name of the enteral or infant formula",
"definition" : "The product or brand name of the enteral or infant formula product such as \"ACME Adult Standard Formula\".",
"min" : 0,
"max" : "1",
"base" : {
"path" : "NutritionOrder.enteralFormula.baseFormulaProductName",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "ODS-4"
},
{
"identity" : "rim",
"map" : ".id"
}]
},
{
"id" : "NutritionOrder.enteralFormula.additiveType",
"path" : "NutritionOrder.enteralFormula.additiveType",
"short" : "Type of modular component to add to the feeding",
"definition" : "Indicates the type of modular component such as protein, carbohydrate, fat or fiber to be provided in addition to or mixed with the base formula.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "NutritionOrder.enteralFormula.additiveType",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "EnteralFormulaAdditiveType"
}],
"strength" : "example",
"description" : "Codes for the type of modular component such as protein, carbohydrate or fiber to be provided in addition to or mixed with the base formula.",
"valueSet" : "http://hl7.org/fhir/ValueSet/entformula-additive"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.code"
},
{
"identity" : "w5",
"map" : "FiveWs.what[x]"
},
{
"identity" : "v2",
"map" : "ODS-3"
},
{
"identity" : "rim",
"map" : "N/A (not differentiated from NutritionalFormulaType in HL7 v3)"
}]
},
{
"id" : "NutritionOrder.enteralFormula.additiveProductName",
"path" : "NutritionOrder.enteralFormula.additiveProductName",
"short" : "Product or brand name of the modular additive",
"definition" : "The product or brand name of the type of modular component to be added to the formula.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "NutritionOrder.enteralFormula.additiveProductName",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "ODS-4"
},
{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "NutritionOrder.enteralFormula.caloricDensity",
"path" : "NutritionOrder.enteralFormula.caloricDensity",
"short" : "Amount of energy per specified volume that is required",
"definition" : "The amount of energy (calories) that the formula should provide per specified volume, typically per mL or fluid oz. For example, an infant may require a formula that provides 24 calories per fluid ounce or an adult may require an enteral formula that provides 1.5 calorie/mL.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "NutritionOrder.enteralFormula.caloricDensity",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Quantity",
"profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "TQ1-2"
},
{
"identity" : "rim",
"map" : ".quantity (caloricDensity)"
}]
},
{
"id" : "NutritionOrder.enteralFormula.routeofAdministration",
"path" : "NutritionOrder.enteralFormula.routeofAdministration",
"short" : "How the formula should enter the patient's gastrointestinal tract",
"definition" : "The route or physiological path of administration into the patient's gastrointestinal tract for purposes of providing the formula feeding, e.g. nasogastric tube.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "NutritionOrder.enteralFormula.routeofAdministration",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "EnteralRouteOfAdministration"
}],
"strength" : "extensible",
"description" : "Codes specifying the route of administration of enteral formula.",
"valueSet" : "http://hl7.org/fhir/ValueSet/enteral-route"
},
"mapping" : [{
"identity" : "v2",
"map" : "ODS-4"
},
{
"identity" : "rim",
"map" : ".routeCode"
}]
},
{
"id" : "NutritionOrder.enteralFormula.administration",
"path" : "NutritionOrder.enteralFormula.administration",
"short" : "Formula feeding instruction as structured data",
"definition" : "Formula administration instructions as structured data. This repeating structure allows for changing the administration rate or volume over time for both bolus and continuous feeding. An example of this would be an instruction to increase the rate of continuous feeding every 2 hours.",
"comment" : "See implementation notes below for further discussion on how to order continuous vs bolus enteral feeding using this resource.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "NutritionOrder.enteralFormula.administration",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "ODS-4"
},
{
"identity" : "rim",
"map" : ".outboundRelationship [typeCode =COMP], target [classCode=SBADM, moodCode=RQO]"
}]
},
{
"id" : "NutritionOrder.enteralFormula.administration.id",
"path" : "NutritionOrder.enteralFormula.administration.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "NutritionOrder.enteralFormula.administration.extension",
"path" : "NutritionOrder.enteralFormula.administration.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "NutritionOrder.enteralFormula.administration.modifierExtension",
"path" : "NutritionOrder.enteralFormula.administration.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "NutritionOrder.enteralFormula.administration.schedule",
"path" : "NutritionOrder.enteralFormula.administration.schedule",
"short" : "Scheduled frequency of enteral feeding",
"definition" : "The time period and frequency at which the enteral formula should be delivered to the patient.",
"alias" : ["Frequency"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "NutritionOrder.enteralFormula.administration.schedule",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Timing"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.occurrence[x]"
},
{
"identity" : "v2",
"map" : "ODS-2,TQ1-7/8"
},
{
"identity" : "rim",
"map" : ".effectiveUseTime"
}]
},
{
"id" : "NutritionOrder.enteralFormula.administration.quantity",
"path" : "NutritionOrder.enteralFormula.administration.quantity",
"short" : "The volume of formula to provide",
"definition" : "The volume of formula to provide to the patient per the specified administration schedule.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "NutritionOrder.enteralFormula.administration.quantity",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Quantity",
"profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "TQ1-2"
},
{
"identity" : "rim",
"map" : ".doseQuantity"
}]
},
{
"id" : "NutritionOrder.enteralFormula.administration.rate[x]",
"path" : "NutritionOrder.enteralFormula.administration.rate[x]",
"short" : "Speed with which the formula is provided per period of time",
"definition" : "The rate of administration of formula via a feeding pump, e.g. 60 mL per hour, according to the specified schedule.",
"comment" : "Ratio is used when the quantity value in the denominator is not \"1\", otherwise use Quantity. For example, the Ratio datatype is used for \"200 mL/4 hrs\" versus the Quantity datatype for \"50 mL/hr\".",
"min" : 0,
"max" : "1",
"base" : {
"path" : "NutritionOrder.enteralFormula.administration.rate[x]",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Quantity",
"profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
},
{
"code" : "Ratio"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "ODS-4"
},
{
"identity" : "rim",
"map" : ".rateQuantity"
}]
},
{
"id" : "NutritionOrder.enteralFormula.maxVolumeToDeliver",
"path" : "NutritionOrder.enteralFormula.maxVolumeToDeliver",
"short" : "Upper limit on formula volume per unit of time",
"definition" : "The maximum total quantity of formula that may be administered to a subject over the period of time, e.g. 1440 mL over 24 hours.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "NutritionOrder.enteralFormula.maxVolumeToDeliver",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Quantity",
"profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "ODS-4"
},
{
"identity" : "rim",
"map" : ".maxDoseQuantity"
}]
},
{
"id" : "NutritionOrder.enteralFormula.administrationInstruction",
"path" : "NutritionOrder.enteralFormula.administrationInstruction",
"short" : "Formula feeding instructions expressed as text",
"definition" : "Free text formula administration, feeding instructions or additional instructions or information.",
"comment" : "Free text dosage instructions can be used for cases where the instructions are too complex to code.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "NutritionOrder.enteralFormula.administrationInstruction",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.supportingInfo"
},
{
"identity" : "v2",
"map" : "ODS-4"
},
{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "NutritionOrder.note",
"path" : "NutritionOrder.note",
"short" : "Comments",
"definition" : "Comments made about the {{title}} by the requester, performer, subject or other participants.",
"comment" : "This element SHALL NOT be used to supply free text instructions for the diet which are represented in the `.oralDiet.instruction`, `supplement.instruction`, or `enteralFormula.administrationInstruction` elements.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "NutritionOrder.note",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Annotation"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.note"
}]
}]
},
"differential" : {
"element" : [{
"id" : "NutritionOrder",
"path" : "NutritionOrder",
"short" : "Diet, formula or nutritional supplement request",
"definition" : "A request to supply a diet, formula feeding (enteral) or oral nutritional supplement to a patient/resident.",
"comment" : "Referenced by an Order Request (workflow).",
"alias" : ["Nutrition Order",
"Diet Order",
"Diet",
"Nutritional Supplement",
"Enteral Nutrition"],
"min" : 0,
"max" : "*",
"constraint" : [{
"key" : "nor-1",
"severity" : "warning",
"human" : "Nutrition Order SHALL contain either Oral Diet , Supplement, or Enteral Formula class",
"expression" : "oralDiet.exists() or supplement.exists() or enteralFormula.exists()",
"xpath" : "exists(f:oralDiet) or exists(f:supplement) or exists(f:enteralFormula)"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Request"
},
{
"identity" : "v2",
"map" : "ORC / ODS"
},
{
"identity" : "rim",
"map" : "SupplyRequest"
}]
},
{
"id" : "NutritionOrder.identifier",
"path" : "NutritionOrder.identifier",
"short" : "Identifiers assigned to this order",
"definition" : "Identifiers assigned to this order by the order sender or by the order receiver.",
"comment" : "The Identifier.type element can be to indicate filler vs. placer if needed. This is explained in further detail [here](servicerequest.html#notes).",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Identifier"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Request.identifier"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "v2",
"map" : "ORC-2/ORC-3"
},
{
"identity" : "rim",
"map" : ".id"
}]
},
{
"id" : "NutritionOrder.instantiatesCanonical",
"path" : "NutritionOrder.instantiatesCanonical",
"short" : "Instantiates FHIR protocol or definition",
"definition" : "The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this NutritionOrder.",
"comment" : "Note: This is a business identifier, not a resource identifier (see [discussion](resource.html#identifiers)). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ActivityDefinition",
"http://hl7.org/fhir/StructureDefinition/PlanDefinition"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.instantiatesCanonical"
},
{
"identity" : "v2",
"map" : "Varies by domain"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=DEFN].target"
}]
},
{
"id" : "NutritionOrder.instantiatesUri",
"path" : "NutritionOrder.instantiatesUri",
"short" : "Instantiates external protocol or definition",
"definition" : "The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this NutritionOrder.",
"comment" : "This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "uri"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.instantiatesUri"
},
{
"identity" : "v2",
"map" : "Varies by domain"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=DEFN].target"
}]
},
{
"id" : "NutritionOrder.instantiates",
"path" : "NutritionOrder.instantiates",
"short" : "Instantiates protocol or definition",
"definition" : "The URL pointing to a protocol, guideline, orderset or other definition that is adhered to in whole or in part by this NutritionOrder.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "uri"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Request.instantiates"
},
{
"identity" : "v2",
"map" : "Varies by domain"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=DEFN].target"
}]
},
{
"id" : "NutritionOrder.status",
"path" : "NutritionOrder.status",
"short" : "draft | active | on-hold | revoked | completed | entered-in-error | unknown",
"definition" : "The workflow status of the nutrition order/request.",
"comment" : "Typically the system placing the order sets the status to \"requested\". Thereafter, the order is maintained by the receiver that updates the status as the request is handled. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "NutritionOrderStatus"
}],
"strength" : "required",
"description" : "Codes identifying the lifecycle stage of the nutrition order.",
"valueSet" : "http://hl7.org/fhir/ValueSet/request-status|4.0.1"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.status"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
},
{
"identity" : "v2",
"map" : "ORC-1"
},
{
"identity" : "rim",
"map" : ".statusCode"
}]
},
{
"id" : "NutritionOrder.intent",
"path" : "NutritionOrder.intent",
"short" : "proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option",
"definition" : "Indicates the level of authority/intentionality associated with the NutrionOrder and where the request fits into the workflow chain.",
"comment" : "When resources map to this element, they are free to define as many codes as necessary to cover their space and will map to \"proposal, plan or order\". Can have multiple codes that map to one of these. E.g. \"original order\", \"encoded order\", \"reflex order\" would all map to \"order\". Expectation is that the set of codes is mutually exclusive or a strict all-encompassing hierarchy.",
"requirements" : "Proposals/recommendations, plans and orders all use the same structure and can exist in the same fulfillment chain.",
"alias" : ["category"],
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isModifier" : true,
"isModifierReason" : "This element changes the interpretation of all descriptive attributes. For example \"the time the request is recommended to occur\" vs. \"the time the request is authorized to occur\" or \"who is recommended to perform the request\" vs. \"who is authorized to perform the request",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "NutritiionOrderIntent"
}],
"strength" : "required",
"description" : "Codes indicating the degree of authority/intentionality associated with a nutrition order.",
"valueSet" : "http://hl7.org/fhir/ValueSet/request-intent|4.0.1"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.intent"
},
{
"identity" : "w5",
"map" : "FiveWs.class"
},
{
"identity" : "v2",
"map" : "N/A"
},
{
"identity" : "rim",
"map" : ".moodCode (nuances beyond PRP/PLAN/RQO would need to be elsewhere)"
}]
},
{
"id" : "NutritionOrder.patient",
"path" : "NutritionOrder.patient",
"short" : "The person who requires the diet, formula or nutritional supplement",
"definition" : "The person (patient) who needs the nutrition order for an oral diet, nutritional supplement and/or enteral or formula feeding.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.subject"
},
{
"identity" : "w5",
"map" : "FiveWs.subject[x]"
},
{
"identity" : "v2",
"map" : "PID"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=SBJ].role"
},
{
"identity" : "w5",
"map" : "FiveWs.subject"
}]
},
{
"id" : "NutritionOrder.encounter",
"path" : "NutritionOrder.encounter",
"short" : "The encounter associated with this nutrition order",
"definition" : "An encounter that provides additional information about the healthcare context in which this request is made.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Encounter"]
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Request.encounter"
},
{
"identity" : "w5",
"map" : "FiveWs.context"
},
{
"identity" : "v2",
"map" : "PV1"
},
{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN]"
}]
},
{
"id" : "NutritionOrder.dateTime",
"path" : "NutritionOrder.dateTime",
"short" : "Date and time the nutrition order was requested",
"definition" : "The date and time that this nutrition order was requested.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "dateTime"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.authoredOn"
},
{
"identity" : "w5",
"map" : "FiveWs.recorded"
},
{
"identity" : "v2",
"map" : "ORC-9"
},
{
"identity" : "rim",
"map" : "author.time"
}]
},
{
"id" : "NutritionOrder.orderer",
"path" : "NutritionOrder.orderer",
"short" : "Who ordered the diet, formula or nutritional supplement",
"definition" : "The practitioner that holds legal responsibility for ordering the diet, nutritional supplement, or formula feedings.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.requester"
},
{
"identity" : "w5",
"map" : "FiveWs.author"
},
{
"identity" : "v2",
"map" : "ORC-12"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=AUT].role"
}]
},
{
"id" : "NutritionOrder.allergyIntolerance",
"path" : "NutritionOrder.allergyIntolerance",
"short" : "List of the patient's food and nutrition-related allergies and intolerances",
"definition" : "A link to a record of allergies or intolerances which should be included in the nutrition order.",
"comment" : "Information on a patient's food allergies and intolerances to inform healthcare personnel about the type of foods that the patient shouldn't receive or consume.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/AllergyIntolerance"]
}],
"mapping" : [{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=RSON].target[classCode=OBS, moodCode=EVN]"
}]
},
{
"id" : "NutritionOrder.foodPreferenceModifier",
"path" : "NutritionOrder.foodPreferenceModifier",
"short" : "Order-specific modifier about the type of food that should be given",
"definition" : "This modifier is used to convey order-specific modifiers about the type of food that should be given. These can be derived from patient allergies, intolerances, or preferences such as Halal, Vegan or Kosher. This modifier applies to the entire nutrition order inclusive of the oral diet, nutritional supplements and enteral formula feedings.",
"comment" : "Information on a patient's food preferences that inform healthcare personnel about the food that the patient should receive or consume.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "PatientDiet"
}],
"strength" : "example",
"description" : "Medical, cultural or ethical food preferences to help with catering requirements.",
"valueSet" : "http://hl7.org/fhir/ValueSet/encounter-diet"
},
"mapping" : [{
"identity" : "v2",
"map" : "ODS-1 Value = \"P\",ODS-3"
},
{
"identity" : "rim",
"map" : ".outboundRelationship [typeCode =COMP], target [classCode=PROC, moodCode=EVN, code=NutritionModificationType]"
}]
},
{
"id" : "NutritionOrder.excludeFoodModifier",
"path" : "NutritionOrder.excludeFoodModifier",
"short" : "Order-specific modifier about the type of food that should not be given",
"definition" : "This modifier is used to convey Order-specific modifier about the type of oral food or oral fluids that should not be given. These can be derived from patient allergies, intolerances, or preferences such as No Red Meat, No Soy or No Wheat or Gluten-Free. While it should not be necessary to repeat allergy or intolerance information captured in the referenced AllergyIntolerance resource in the excludeFoodModifier, this element may be used to convey additional specificity related to foods that should be eliminated from the patient’s diet for any reason. This modifier applies to the entire nutrition order inclusive of the oral diet, nutritional supplements and enteral formula feedings.",
"comment" : "Information on a patient's food allergies, intolerances and preferences to inform healthcare personnel about the type of foods that the patient shouldn't receive or consume.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "FoodType"
}],
"strength" : "example",
"description" : "Codes used to indicate the type of food that should NOT be given to the patient.",
"valueSet" : "http://hl7.org/fhir/ValueSet/food-type"
},
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "NutritionOrder.oralDiet",
"path" : "NutritionOrder.oralDiet",
"short" : "Oral diet components",
"definition" : "Diet given orally in contrast to enteral (tube) feeding.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "BackboneElement"
}],
"condition" : ["nor-1"],
"mapping" : [{
"identity" : "v2",
"map" : "ODS-1 Value = \"D\""
},
{
"identity" : "rim",
"map" : "oralDiet .outboundRelationship [typeCode =COMP], target [classCode=SPLY, moodCode=RQO, code=OralDietSupplyType]"
}]
},
{
"id" : "NutritionOrder.oralDiet.type",
"path" : "NutritionOrder.oralDiet.type",
"short" : "Type of oral diet or diet restrictions that describe what can be consumed orally",
"definition" : "The kind of diet or dietary restriction such as fiber restricted diet or diabetic diet.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "OralDiet"
}],
"strength" : "example",
"description" : "Codes used to indicate the type of diet being ordered for a patient.",
"valueSet" : "http://hl7.org/fhir/ValueSet/diet-type"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.code"
},
{
"identity" : "w5",
"map" : "FiveWs.what[x]"
},
{
"identity" : "v2",
"map" : "ODS-3"
},
{
"identity" : "rim",
"map" : ".code"
}]
},
{
"id" : "NutritionOrder.oralDiet.schedule",
"path" : "NutritionOrder.oralDiet.schedule",
"short" : "Scheduled frequency of diet",
"definition" : "The time period and frequency at which the diet should be given. The diet should be given for the combination of all schedules if more than one schedule is present.",
"alias" : ["Frequency"],
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Timing"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Request.occurrence[x]"
},
{
"identity" : "v2",
"map" : "ODS-2, TQ1-7/8"
},
{
"identity" : "rim",
"map" : ".expectedUseTime"
}]
},
{
"id" : "NutritionOrder.oralDiet.nutrient",
"path" : "NutritionOrder.oralDiet.nutrient",
"short" : "Required nutrient modifications",
"definition" : "Class that defines the quantity and type of nutrient modifications (for example carbohydrate, fiber or sodium) required for the oral diet.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"mapping" : [{
"identity" : "v2",
"map" : "ODS-4"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=PRD].role[classCode=MANU], manufacturedFoodKind"
}]
},
{
"id" : "NutritionOrder.oralDiet.nutrient.modifier",
"path" : "NutritionOrder.oralDiet.nutrient.modifier",
"short" : "Type of nutrient that is being modified",
"definition" : "The nutrient that is being modified such as carbohydrate or sodium.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "NutrientModifier"
}],
"strength" : "example",
"description" : "Codes for types of nutrients that are being modified such as carbohydrate or sodium.",
"valueSet" : "http://hl7.org/fhir/ValueSet/nutrient-code"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.code"
},
{
"identity" : "w5",
"map" : "FiveWs.what[x]"
},
{
"identity" : "v2",
"map" : "ODS-4"
},
{
"identity" : "rim",
"map" : ".code"
}]
},
{
"id" : "NutritionOrder.oralDiet.nutrient.amount",
"path" : "NutritionOrder.oralDiet.nutrient.amount",
"short" : "Quantity of the specified nutrient",
"definition" : "The quantity of the specified nutrient to include in diet.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Quantity",
"profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
}],
"mapping" : [{
"identity" : "v2",
"map" : "ODS-4"
},
{
"identity" : "rim",
"map" : ".quantity"
}]
},
{
"id" : "NutritionOrder.oralDiet.texture",
"path" : "NutritionOrder.oralDiet.texture",
"short" : "Required texture modifications",
"definition" : "Class that describes any texture modifications required for the patient to safely consume various types of solid foods.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"mapping" : [{
"identity" : "v2",
"map" : "ODS-4"
},
{
"identity" : "rim",
"map" : ".inboundRelationship [typeCode =COMP], target [classCode=PROC, moodCode=EVN, code=DietTextureModificationType]"
}]
},
{
"id" : "NutritionOrder.oralDiet.texture.modifier",
"path" : "NutritionOrder.oralDiet.texture.modifier",
"short" : "Code to indicate how to alter the texture of the foods, e.g. pureed",
"definition" : "Any texture modifications (for solid foods) that should be made, e.g. easy to chew, chopped, ground, and pureed.",
"comment" : "Coupled with the foodType (Meat).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "TextureModifier"
}],
"strength" : "example",
"description" : "Codes for food consistency types or texture modifications to apply to foods.",
"valueSet" : "http://hl7.org/fhir/ValueSet/texture-code"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.code"
},
{
"identity" : "v2",
"map" : "ODS-4"
},
{
"identity" : "rim",
"map" : ".code"
}]
},
{
"id" : "NutritionOrder.oralDiet.texture.foodType",
"path" : "NutritionOrder.oralDiet.texture.foodType",
"short" : "Concepts that are used to identify an entity that is ingested for nutritional purposes",
"definition" : "The food type(s) (e.g. meats, all foods) that the texture modification applies to. This could be all foods types.",
"comment" : "Coupled with the `texture.modifier`; could be (All Foods).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "TextureModifiedFoodType"
}],
"strength" : "example",
"description" : "Codes for types of foods that are texture-modified.",
"valueSet" : "http://hl7.org/fhir/ValueSet/modified-foodtype"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.code"
},
{
"identity" : "v2",
"map" : "ODS-4"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=PRD].role[classCode=MANU], manufacturedFoodKind; .code"
}]
},
{
"id" : "NutritionOrder.oralDiet.fluidConsistencyType",
"path" : "NutritionOrder.oralDiet.fluidConsistencyType",
"short" : "The required consistency of fluids and liquids provided to the patient",
"definition" : "The required consistency (e.g. honey-thick, nectar-thick, thin, thickened.) of liquids or fluids served to the patient.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "FluidConsistencyType"
}],
"strength" : "example",
"description" : "Codes used to represent the consistency of fluids and liquids provided to the patient.",
"valueSet" : "http://hl7.org/fhir/ValueSet/consistency-type"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.code"
},
{
"identity" : "v2",
"map" : "ODS-4"
},
{
"identity" : "rim",
"map" : ".code (Not differentiated from dietTextureModificationType in HL7 v3)"
}]
},
{
"id" : "NutritionOrder.oralDiet.instruction",
"path" : "NutritionOrder.oralDiet.instruction",
"short" : "Instructions or additional information about the oral diet",
"definition" : "Free text or additional instructions or information pertaining to the oral diet.",
"comment" : "Free text dosage instructions can be used for cases where the instructions are too complex to code.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.supportingInfo"
},
{
"identity" : "v2",
"map" : "ODS-4"
},
{
"identity" : "rim",
"map" : ".text"
}]
},
{
"id" : "NutritionOrder.supplement",
"path" : "NutritionOrder.supplement",
"short" : "Supplement components",
"definition" : "Oral nutritional products given in order to add further nutritional value to the patient's diet.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"condition" : ["nor-1"],
"mapping" : [{
"identity" : "v2",
"map" : "ODS-1 Value = \"P\""
},
{
"identity" : "rim",
"map" : ".outboundRelationship [typeCode =COMP], target [classCode=SPLY, moodCode=RQO, code=SUPPLEMENT]"
}]
},
{
"id" : "NutritionOrder.supplement.type",
"path" : "NutritionOrder.supplement.type",
"short" : "Type of supplement product requested",
"definition" : "The kind of nutritional supplement product required such as a high protein or pediatric clear liquid supplement.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SupplementType"
}],
"strength" : "example",
"description" : "Codes for nutritional supplements to be provided to the patient.",
"valueSet" : "http://hl7.org/fhir/ValueSet/supplement-type"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.code"
},
{
"identity" : "w5",
"map" : "FiveWs.what[x]"
},
{
"identity" : "v2",
"map" : "ODS-3"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=PRD].role[classCode=MANU], manufacturedFoodKind; .code (NutritionalSupplementType)"
}]
},
{
"id" : "NutritionOrder.supplement.productName",
"path" : "NutritionOrder.supplement.productName",
"short" : "Product or brand name of the nutritional supplement",
"definition" : "The product or brand name of the nutritional supplement such as \"Acme Protein Shake\".",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"mapping" : [{
"identity" : "v2",
"map" : "ODS-3"
},
{
"identity" : "rim",
"map" : ".id"
}]
},
{
"id" : "NutritionOrder.supplement.schedule",
"path" : "NutritionOrder.supplement.schedule",
"short" : "Scheduled frequency of supplement",
"definition" : "The time period and frequency at which the supplement(s) should be given. The supplement should be given for the combination of all schedules if more than one schedule is present.",
"alias" : ["Frequency"],
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Timing"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Request.occurrence[x]"
},
{
"identity" : "v2",
"map" : "ODS-2,TQ1-7/8"
},
{
"identity" : "rim",
"map" : ".effectiveTime"
}]
},
{
"id" : "NutritionOrder.supplement.quantity",
"path" : "NutritionOrder.supplement.quantity",
"short" : "Amount of the nutritional supplement",
"definition" : "The amount of the nutritional supplement to be given.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Quantity",
"profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
}],
"mapping" : [{
"identity" : "v2",
"map" : "TQ1-2"
},
{
"identity" : "rim",
"map" : ".quantity"
}]
},
{
"id" : "NutritionOrder.supplement.instruction",
"path" : "NutritionOrder.supplement.instruction",
"short" : "Instructions or additional information about the oral supplement",
"definition" : "Free text or additional instructions or information pertaining to the oral supplement.",
"comment" : "Free text dosage instructions can be used for cases where the instructions are too complex to code.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.supportingInfo"
},
{
"identity" : "v2",
"map" : "ODS-4"
},
{
"identity" : "rim",
"map" : ".text"
}]
},
{
"id" : "NutritionOrder.enteralFormula",
"path" : "NutritionOrder.enteralFormula",
"short" : "Enteral formula components",
"definition" : "Feeding provided through the gastrointestinal tract via a tube, catheter, or stoma that delivers nutrition distal to the oral cavity.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "BackboneElement"
}],
"condition" : ["nor-1"],
"mapping" : [{
"identity" : "v2",
"map" : "ODS-1 Value coded for enteral"
},
{
"identity" : "rim",
"map" : ".outboundRelationship [typeCode =COMP], target [classCode=SPLY, moodCode=RQO, code=FORMULA]"
}]
},
{
"id" : "NutritionOrder.enteralFormula.baseFormulaType",
"path" : "NutritionOrder.enteralFormula.baseFormulaType",
"short" : "Type of enteral or infant formula",
"definition" : "The type of enteral or infant formula such as an adult standard formula with fiber or a soy-based infant formula.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "EnteralFormulaType"
}],
"strength" : "example",
"description" : "Codes for type of enteral formula to be administered to patient.",
"valueSet" : "http://hl7.org/fhir/ValueSet/entformula-type"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.code"
},
{
"identity" : "w5",
"map" : "FiveWs.what[x]"
},
{
"identity" : "v2",
"map" : "ODS-3"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=PRD].role[classCode=MANU], manufacturedFoodKind; .code (NutritionalFormulaType)"
}]
},
{
"id" : "NutritionOrder.enteralFormula.baseFormulaProductName",
"path" : "NutritionOrder.enteralFormula.baseFormulaProductName",
"short" : "Product or brand name of the enteral or infant formula",
"definition" : "The product or brand name of the enteral or infant formula product such as \"ACME Adult Standard Formula\".",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"mapping" : [{
"identity" : "v2",
"map" : "ODS-4"
},
{
"identity" : "rim",
"map" : ".id"
}]
},
{
"id" : "NutritionOrder.enteralFormula.additiveType",
"path" : "NutritionOrder.enteralFormula.additiveType",
"short" : "Type of modular component to add to the feeding",
"definition" : "Indicates the type of modular component such as protein, carbohydrate, fat or fiber to be provided in addition to or mixed with the base formula.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "EnteralFormulaAdditiveType"
}],
"strength" : "example",
"description" : "Codes for the type of modular component such as protein, carbohydrate or fiber to be provided in addition to or mixed with the base formula.",
"valueSet" : "http://hl7.org/fhir/ValueSet/entformula-additive"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.code"
},
{
"identity" : "w5",
"map" : "FiveWs.what[x]"
},
{
"identity" : "v2",
"map" : "ODS-3"
},
{
"identity" : "rim",
"map" : "N/A (not differentiated from NutritionalFormulaType in HL7 v3)"
}]
},
{
"id" : "NutritionOrder.enteralFormula.additiveProductName",
"path" : "NutritionOrder.enteralFormula.additiveProductName",
"short" : "Product or brand name of the modular additive",
"definition" : "The product or brand name of the type of modular component to be added to the formula.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"mapping" : [{
"identity" : "v2",
"map" : "ODS-4"
},
{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "NutritionOrder.enteralFormula.caloricDensity",
"path" : "NutritionOrder.enteralFormula.caloricDensity",
"short" : "Amount of energy per specified volume that is required",
"definition" : "The amount of energy (calories) that the formula should provide per specified volume, typically per mL or fluid oz. For example, an infant may require a formula that provides 24 calories per fluid ounce or an adult may require an enteral formula that provides 1.5 calorie/mL.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Quantity",
"profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
}],
"mapping" : [{
"identity" : "v2",
"map" : "TQ1-2"
},
{
"identity" : "rim",
"map" : ".quantity (caloricDensity)"
}]
},
{
"id" : "NutritionOrder.enteralFormula.routeofAdministration",
"path" : "NutritionOrder.enteralFormula.routeofAdministration",
"short" : "How the formula should enter the patient's gastrointestinal tract",
"definition" : "The route or physiological path of administration into the patient's gastrointestinal tract for purposes of providing the formula feeding, e.g. nasogastric tube.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "EnteralRouteOfAdministration"
}],
"strength" : "extensible",
"description" : "Codes specifying the route of administration of enteral formula.",
"valueSet" : "http://hl7.org/fhir/ValueSet/enteral-route"
},
"mapping" : [{
"identity" : "v2",
"map" : "ODS-4"
},
{
"identity" : "rim",
"map" : ".routeCode"
}]
},
{
"id" : "NutritionOrder.enteralFormula.administration",
"path" : "NutritionOrder.enteralFormula.administration",
"short" : "Formula feeding instruction as structured data",
"definition" : "Formula administration instructions as structured data. This repeating structure allows for changing the administration rate or volume over time for both bolus and continuous feeding. An example of this would be an instruction to increase the rate of continuous feeding every 2 hours.",
"comment" : "See implementation notes below for further discussion on how to order continuous vs bolus enteral feeding using this resource.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"mapping" : [{
"identity" : "v2",
"map" : "ODS-4"
},
{
"identity" : "rim",
"map" : ".outboundRelationship [typeCode =COMP], target [classCode=SBADM, moodCode=RQO]"
}]
},
{
"id" : "NutritionOrder.enteralFormula.administration.schedule",
"path" : "NutritionOrder.enteralFormula.administration.schedule",
"short" : "Scheduled frequency of enteral feeding",
"definition" : "The time period and frequency at which the enteral formula should be delivered to the patient.",
"alias" : ["Frequency"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Timing"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Request.occurrence[x]"
},
{
"identity" : "v2",
"map" : "ODS-2,TQ1-7/8"
},
{
"identity" : "rim",
"map" : ".effectiveUseTime"
}]
},
{
"id" : "NutritionOrder.enteralFormula.administration.quantity",
"path" : "NutritionOrder.enteralFormula.administration.quantity",
"short" : "The volume of formula to provide",
"definition" : "The volume of formula to provide to the patient per the specified administration schedule.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Quantity",
"profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
}],
"mapping" : [{
"identity" : "v2",
"map" : "TQ1-2"
},
{
"identity" : "rim",
"map" : ".doseQuantity"
}]
},
{
"id" : "NutritionOrder.enteralFormula.administration.rate[x]",
"path" : "NutritionOrder.enteralFormula.administration.rate[x]",
"short" : "Speed with which the formula is provided per period of time",
"definition" : "The rate of administration of formula via a feeding pump, e.g. 60 mL per hour, according to the specified schedule.",
"comment" : "Ratio is used when the quantity value in the denominator is not \"1\", otherwise use Quantity. For example, the Ratio datatype is used for \"200 mL/4 hrs\" versus the Quantity datatype for \"50 mL/hr\".",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Quantity",
"profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
},
{
"code" : "Ratio"
}],
"mapping" : [{
"identity" : "v2",
"map" : "ODS-4"
},
{
"identity" : "rim",
"map" : ".rateQuantity"
}]
},
{
"id" : "NutritionOrder.enteralFormula.maxVolumeToDeliver",
"path" : "NutritionOrder.enteralFormula.maxVolumeToDeliver",
"short" : "Upper limit on formula volume per unit of time",
"definition" : "The maximum total quantity of formula that may be administered to a subject over the period of time, e.g. 1440 mL over 24 hours.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Quantity",
"profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
}],
"mapping" : [{
"identity" : "v2",
"map" : "ODS-4"
},
{
"identity" : "rim",
"map" : ".maxDoseQuantity"
}]
},
{
"id" : "NutritionOrder.enteralFormula.administrationInstruction",
"path" : "NutritionOrder.enteralFormula.administrationInstruction",
"short" : "Formula feeding instructions expressed as text",
"definition" : "Free text formula administration, feeding instructions or additional instructions or information.",
"comment" : "Free text dosage instructions can be used for cases where the instructions are too complex to code.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.supportingInfo"
},
{
"identity" : "v2",
"map" : "ODS-4"
},
{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "NutritionOrder.note",
"path" : "NutritionOrder.note",
"short" : "Comments",
"definition" : "Comments made about the {{title}} by the requester, performer, subject or other participants.",
"comment" : "This element SHALL NOT be used to supply free text instructions for the diet which are represented in the `.oralDiet.instruction`, `supplement.instruction`, or `enteralFormula.administrationInstruction` elements.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Annotation"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Request.note"
}]
}]
}
}
},
{
"fullUrl" : "http://hl7.org/fhir/StructureDefinition/Observation",
"resource" : {
"resourceType" : "StructureDefinition",
"id" : "Observation",
"meta" : {
"lastUpdated" : "2019-11-01T09:29:23.356+11:00"
},
"text" : {
"status" : "generated",
"div" : "Name Flags Card. Type Description & Constraints Observation IN DomainResource Measurements and simple assertions
+ Rule: dataAbsentReason SHALL only be present if Observation.value[x] is not present
+ Rule: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension identifier Σ 0..* Identifier Business Identifier for observation
basedOn Σ 0..* Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) Fulfills plan, proposal or order
partOf Σ 0..* Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) Part of referenced event
status ?!Σ 1..1 code registered | preliminary | final | amended +
ObservationStatus (Required) category 0..* CodeableConcept Classification of type of observation
Observation Category Codes (Preferred)
code Σ 1..1 CodeableConcept Type of observation (code / type)
LOINC Codes (Example) subject Σ 0..1 Reference(Patient | Group | Device | Location) Who and/or what the observation is about focus ΣTU 0..* Reference(Any) What the observation is about, when it is not about the subject of record
encounter Σ 0..1 Reference(Encounter) Healthcare event during which this observation is made effective[x] Σ 0..1 Clinically relevant time/time-period for observation effectiveDateTime dateTime effectivePeriod Period effectiveTiming Timing effectiveInstant instant issued Σ 0..1 instant Date/Time this version was made available performer Σ 0..* Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) Who is responsible for the observation
value[x] ΣI 0..1 Actual result valueQuantity Quantity valueCodeableConcept CodeableConcept valueString string valueBoolean boolean valueInteger integer valueRange Range valueRatio Ratio valueSampledData SampledData valueTime time valueDateTime dateTime valuePeriod Period dataAbsentReason I 0..1 CodeableConcept Why the result is missing
DataAbsentReason (Extensible) interpretation 0..* CodeableConcept High, low, normal, etc.
Observation Interpretation Codes (Extensible)
note 0..* Annotation Comments about the observation
bodySite 0..1 CodeableConcept Observed body part
SNOMED CT Body Structures (Example) method 0..1 CodeableConcept How it was done
Observation Methods (Example) specimen 0..1 Reference(Specimen) Specimen used for this observation device 0..1 Reference(Device | DeviceMetric) (Measurement) Device referenceRange I 0..* BackboneElement Provides guide for interpretation
+ Rule: Must have at least a low or a high or text
low I 0..1 SimpleQuantity Low Range, if relevant high I 0..1 SimpleQuantity High Range, if relevant type 0..1 CodeableConcept Reference range qualifier
Observation Reference Range Meaning Codes (Preferred) appliesTo 0..* CodeableConcept Reference range population
Observation Reference Range Applies To Codes (Example)
age 0..1 Range Applicable age range, if relevant text 0..1 string Text based reference range in an observation hasMember Σ 0..* Reference(Observation | QuestionnaireResponse | MolecularSequence) Related resource that belongs to the Observation group
derivedFrom Σ 0..* Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) Related measurements the observation is made from
component Σ 0..* BackboneElement Component results
code Σ 1..1 CodeableConcept Type of component observation (code / type)
LOINC Codes (Example) value[x] Σ 0..1 Actual component result valueQuantity Quantity valueCodeableConcept CodeableConcept valueString string valueBoolean boolean valueInteger integer valueRange Range valueRatio Ratio valueSampledData SampledData valueTime time valueDateTime dateTime valuePeriod Period dataAbsentReason I 0..1 CodeableConcept Why the component result is missing
DataAbsentReason (Extensible) interpretation 0..* CodeableConcept High, low, normal, etc.
Observation Interpretation Codes (Extensible)
referenceRange 0..* see referenceRange Provides guide for interpretation of component result
Documentation for this format
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Clinical.Diagnostics"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "normative"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode" : "4.0.0"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 5
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "patient"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "oo"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/Observation",
"version" : "4.0.1",
"name" : "Observation",
"status" : "active",
"date" : "2019-11-01T09:29:23+11:00",
"publisher" : "Health Level Seven International (Orders and Observations)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/orders/index.cfm"
}]
}],
"description" : "Measurements and simple assertions made about a patient, device or other subject.",
"purpose" : "Observations are a key aspect of healthcare. This resource is used to capture those that do not require more sophisticated mechanisms.",
"fhirVersion" : "4.0.1",
"mapping" : [{
"identity" : "workflow",
"uri" : "http://hl7.org/fhir/workflow",
"name" : "Workflow Pattern"
},
{
"identity" : "sct-concept",
"uri" : "http://snomed.info/conceptdomain",
"name" : "SNOMED CT Concept Domain Binding"
},
{
"identity" : "v2",
"uri" : "http://hl7.org/v2",
"name" : "HL7 v2 Mapping"
},
{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/fivews",
"name" : "FiveWs Pattern Mapping"
},
{
"identity" : "sct-attr",
"uri" : "http://snomed.org/attributebinding",
"name" : "SNOMED CT Attribute Binding"
}],
"kind" : "resource",
"abstract" : false,
"type" : "Observation",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "Observation",
"path" : "Observation",
"short" : "Measurements and simple assertions",
"definition" : "Measurements and simple assertions made about a patient, device or other subject.",
"comment" : "Used for simple observations such as device measurements, laboratory atomic results, vital signs, height, weight, smoking status, comments, etc. Other resources are used to provide context for observations such as laboratory reports, etc.",
"alias" : ["Vital Signs",
"Measurement",
"Results",
"Tests"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Observation",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "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",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.`div`.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "obs-6",
"severity" : "error",
"human" : "dataAbsentReason SHALL only be present if Observation.value[x] is not present",
"expression" : "dataAbsentReason.empty() or value.empty()",
"xpath" : "not(exists(f:dataAbsentReason)) or (not(exists(*[starts-with(local-name(.), 'value')])))"
},
{
"key" : "obs-7",
"severity" : "error",
"human" : "If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present",
"expression" : "value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()",
"xpath" : "not(f:*[starts-with(local-name(.), 'value')] and (for $coding in f:code/f:coding return f:component/f:code/f:coding[f:code/@value=$coding/f:code/@value] [f:system/@value=$coding/f:system/@value]))"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "workflow",
"map" : "Event"
},
{
"identity" : "sct-concept",
"map" : "< 363787002 |Observable entity|"
},
{
"identity" : "v2",
"map" : "OBX"
},
{
"identity" : "rim",
"map" : "Observation[classCode=OBS, moodCode=EVN]"
}]
},
{
"id" : "Observation.id",
"path" : "Observation.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Observation.meta",
"path" : "Observation.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Observation.implicitRules",
"path" : "Observation.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "Observation.language",
"path" : "Observation.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "Observation.text",
"path" : "Observation.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "Observation.contained",
"path" : "Observation.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Observation.extension",
"path" : "Observation.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Observation.modifierExtension",
"path" : "Observation.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Observation.identifier",
"path" : "Observation.identifier",
"short" : "Business Identifier for observation",
"definition" : "A unique identifier assigned to this observation.",
"requirements" : "Allows observations to be distinguished and referenced.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Observation.identifier",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Identifier"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.identifier"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "v2",
"map" : "OBX.21 For OBX segments from systems without OBX-21 support a combination of ORC/OBR and OBX must be negotiated between trading partners to uniquely identify the OBX segment. Depending on how V2 has been implemented each of these may be an option: 1) OBR-3 + OBX-3 + OBX-4 or 2) OBR-3 + OBR-4 + OBX-3 + OBX-4 or 2) some other way to uniquely ID the OBR/ORC + OBX-3 + OBX-4."
},
{
"identity" : "rim",
"map" : "id"
}]
},
{
"id" : "Observation.basedOn",
"path" : "Observation.basedOn",
"short" : "Fulfills plan, proposal or order",
"definition" : "A plan, proposal or order that is fulfilled in whole or in part by this event. For example, a MedicationRequest may require a patient to have laboratory test performed before it is dispensed.",
"requirements" : "Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon.",
"alias" : ["Fulfills"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Observation.basedOn",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/CarePlan",
"http://hl7.org/fhir/StructureDefinition/DeviceRequest",
"http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation",
"http://hl7.org/fhir/StructureDefinition/MedicationRequest",
"http://hl7.org/fhir/StructureDefinition/NutritionOrder",
"http://hl7.org/fhir/StructureDefinition/ServiceRequest"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.basedOn"
},
{
"identity" : "v2",
"map" : "ORC"
},
{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=COMP].source[moodCode=EVN]"
}]
},
{
"id" : "Observation.partOf",
"path" : "Observation.partOf",
"short" : "Part of referenced event",
"definition" : "A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.",
"comment" : "To link an Observation to an Encounter use `encounter`. See the [Notes](observation.html#obsgrouping) below for guidance on referencing another Observation.",
"alias" : ["Container"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Observation.partOf",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/MedicationAdministration",
"http://hl7.org/fhir/StructureDefinition/MedicationDispense",
"http://hl7.org/fhir/StructureDefinition/MedicationStatement",
"http://hl7.org/fhir/StructureDefinition/Procedure",
"http://hl7.org/fhir/StructureDefinition/Immunization",
"http://hl7.org/fhir/StructureDefinition/ImagingStudy"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.partOf"
},
{
"identity" : "v2",
"map" : "Varies by domain"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=FLFS].target"
}]
},
{
"id" : "Observation.status",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-display-hint",
"valueString" : "default: final"
}],
"path" : "Observation.status",
"short" : "registered | preliminary | final | amended +",
"definition" : "The status of the result value.",
"comment" : "This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.",
"requirements" : "Need to track the status of individual results. Some results are finalized before the whole report is finalized.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Observation.status",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ObservationStatus"
}],
"strength" : "required",
"description" : "Codes providing the status of an observation.",
"valueSet" : "http://hl7.org/fhir/ValueSet/observation-status|4.0.1"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.status"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
},
{
"identity" : "sct-concept",
"map" : "< 445584004 |Report by finality status|"
},
{
"identity" : "v2",
"map" : "OBX-11"
},
{
"identity" : "rim",
"map" : "status Amended & Final are differentiated by whether it is the subject of a ControlAct event with a type of \"revise\""
}]
},
{
"id" : "Observation.category",
"path" : "Observation.category",
"short" : "Classification of type of observation",
"definition" : "A code that classifies the general type of observation being made.",
"comment" : "In addition to the required category valueset, this element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used at once. The level of granularity is defined by the category concepts in the value set.",
"requirements" : "Used for filtering what observations are retrieved and displayed.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Observation.category",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ObservationCategory"
}],
"strength" : "preferred",
"description" : "Codes for high level observation categories.",
"valueSet" : "http://hl7.org/fhir/ValueSet/observation-category"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.class"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=\"COMP].target[classCode=\"LIST\", moodCode=\"EVN\"].code"
}]
},
{
"id" : "Observation.code",
"path" : "Observation.code",
"short" : "Type of observation (code / type)",
"definition" : "Describes what was observed. Sometimes this is called the observation \"name\".",
"comment" : "*All* code-value and, if present, component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.",
"requirements" : "Knowing what kind of observation is being made is essential to understanding the observation.",
"alias" : ["Name"],
"min" : 1,
"max" : "1",
"base" : {
"path" : "Observation.code",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ObservationCode"
}],
"strength" : "example",
"description" : "Codes identifying names of simple observations.",
"valueSet" : "http://hl7.org/fhir/ValueSet/observation-codes"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.code"
},
{
"identity" : "w5",
"map" : "FiveWs.what[x]"
},
{
"identity" : "sct-concept",
"map" : "< 363787002 |Observable entity| OR < 386053000 |Evaluation procedure|"
},
{
"identity" : "v2",
"map" : "OBX-3"
},
{
"identity" : "rim",
"map" : "code"
},
{
"identity" : "sct-attr",
"map" : "116680003 |Is a|"
}]
},
{
"id" : "Observation.subject",
"path" : "Observation.subject",
"short" : "Who and/or what the observation is about",
"definition" : "The patient, or group of patients, location, or device this observation is about and into whose record the observation is placed. If the actual focus of the observation is different from the subject (or a sample of, part, or region of the subject), the `focus` element or the `code` itself specifies the actual focus of the observation.",
"comment" : "One would expect this element to be a cardinality of 1..1. The only circumstance in which the subject can be missing is when the observation is made by a device that does not know the patient. In this case, the observation SHALL be matched to a patient through some context/channel matching technique, and at this point, the observation should be updated.",
"requirements" : "Observations have no value if you don't know who or what they're about.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Observation.subject",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Group",
"http://hl7.org/fhir/StructureDefinition/Device",
"http://hl7.org/fhir/StructureDefinition/Location"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.subject"
},
{
"identity" : "w5",
"map" : "FiveWs.subject[x]"
},
{
"identity" : "v2",
"map" : "PID-3"
},
{
"identity" : "rim",
"map" : "participation[typeCode=RTGT] "
},
{
"identity" : "w5",
"map" : "FiveWs.subject"
}]
},
{
"id" : "Observation.focus",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"path" : "Observation.focus",
"short" : "What the observation is about, when it is not about the subject of record",
"definition" : "The actual focus of an observation when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, fetus, or donor. For example, fetus observations in a mother's record. The focus of an observation could also be an existing condition, an intervention, the subject's diet, another observation of the subject, or a body structure such as tumor or implanted device. An example use case would be using the Observation resource to capture whether the mother is trained to change her child's tracheostomy tube. In this example, the child is the patient of record and the mother is the focus.",
"comment" : "Typically, an observation is made about the subject - a patient, or group of patients, location, or device - and the distinction between the subject and what is directly measured for an observation is specified in the observation code itself ( e.g., \"Blood Glucose\") and does not need to be represented separately using this element. Use `specimen` if a reference to a specimen is required. If a code is required instead of a resource use either `bodysite` for bodysites or the standard extension [focusCode](extension-observation-focuscode.html).",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Observation.focus",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.subject[x]"
},
{
"identity" : "v2",
"map" : "OBX-3"
},
{
"identity" : "rim",
"map" : "participation[typeCode=SBJ]"
},
{
"identity" : "w5",
"map" : "FiveWs.subject"
}]
},
{
"id" : "Observation.encounter",
"path" : "Observation.encounter",
"short" : "Healthcare event during which this observation is made",
"definition" : "The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.",
"comment" : "This will typically be the encounter the event occurred within, but some events may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter (e.g. pre-admission laboratory tests).",
"requirements" : "For some observations it may be important to know the link between an observation and a particular encounter.",
"alias" : ["Context"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Observation.encounter",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Encounter"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.context"
},
{
"identity" : "w5",
"map" : "FiveWs.context"
},
{
"identity" : "v2",
"map" : "PV1"
},
{
"identity" : "rim",
"map" : "inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN]"
}]
},
{
"id" : "Observation.effective[x]",
"path" : "Observation.effective[x]",
"short" : "Clinically relevant time/time-period for observation",
"definition" : "The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the \"physiologically relevant time\". This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.",
"comment" : "At least a date should be present unless this observation is a historical report. For recording imprecise or \"fuzzy\" times (For example, a blood glucose measurement taken \"after breakfast\") use the [Timing](datatypes.html#timing) datatype which allow the measurement to be tied to regular life events.",
"requirements" : "Knowing when an observation was deemed true is important to its relevance as well as determining trends.",
"alias" : ["Occurrence"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Observation.effective[x]",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
},
{
"code" : "Period"
},
{
"code" : "Timing"
},
{
"code" : "instant"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.occurrence[x]"
},
{
"identity" : "w5",
"map" : "FiveWs.done[x]"
},
{
"identity" : "v2",
"map" : "OBX-14, and/or OBX-19 after v2.4 (depends on who observation made)"
},
{
"identity" : "rim",
"map" : "effectiveTime"
}]
},
{
"id" : "Observation.issued",
"path" : "Observation.issued",
"short" : "Date/Time this version was made available",
"definition" : "The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified.",
"comment" : "For Observations that don’t require review and verification, it may be the same as the [`lastUpdated` ](resource-definitions.html#Meta.lastUpdated) time of the resource itself. For Observations that do require review and verification for certain updates, it might not be the same as the `lastUpdated` time of the resource itself due to a non-clinically significant update that doesn’t require the new version to be reviewed and verified again.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Observation.issued",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "instant"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.recorded"
},
{
"identity" : "v2",
"map" : "OBR.22 (or MSH.7), or perhaps OBX-19 (depends on who observation made)"
},
{
"identity" : "rim",
"map" : "participation[typeCode=AUT].time"
}]
},
{
"id" : "Observation.performer",
"path" : "Observation.performer",
"short" : "Who is responsible for the observation",
"definition" : "Who was responsible for asserting the observed value as \"true\".",
"requirements" : "May give a degree of confidence in the observation and also indicates where follow-up questions should be directed.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Observation.performer",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Organization",
"http://hl7.org/fhir/StructureDefinition/CareTeam",
"http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.performer.actor"
},
{
"identity" : "w5",
"map" : "FiveWs.actor"
},
{
"identity" : "v2",
"map" : "OBX.15 / (Practitioner) OBX-16, PRT-5:PRT-4='RO' / (Device) OBX-18 , PRT-10:PRT-4='EQUIP' / (Organization) OBX-23, PRT-8:PRT-4='PO'"
},
{
"identity" : "rim",
"map" : "participation[typeCode=PRF]"
}]
},
{
"id" : "Observation.value[x]",
"path" : "Observation.value[x]",
"short" : "Actual result",
"definition" : "The information determined as a result of making the observation, if the information has a simple value.",
"comment" : "An observation may have; 1) a single value here, 2) both a value and a set of related or component values, or 3) only a set of related or component values. If a value is present, the datatype for this element should be determined by Observation.code. A CodeableConcept with just a text would be used instead of a string if the field was usually coded, or if the type associated with the Observation.code defines a coded value. For additional guidance, see the [Notes section](observation.html#notes) below.",
"requirements" : "An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Observation.value[x]",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Quantity"
},
{
"code" : "CodeableConcept"
},
{
"code" : "string"
},
{
"code" : "boolean"
},
{
"code" : "integer"
},
{
"code" : "Range"
},
{
"code" : "Ratio"
},
{
"code" : "SampledData"
},
{
"code" : "time"
},
{
"code" : "dateTime"
},
{
"code" : "Period"
}],
"condition" : ["obs-7"],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "sct-concept",
"map" : "< 441742003 |Evaluation finding|"
},
{
"identity" : "v2",
"map" : "OBX.2, OBX.5, OBX.6"
},
{
"identity" : "rim",
"map" : "value"
},
{
"identity" : "sct-attr",
"map" : "363714003 |Interprets|"
}]
},
{
"id" : "Observation.dataAbsentReason",
"path" : "Observation.dataAbsentReason",
"short" : "Why the result is missing",
"definition" : "Provides a reason why the expected value in the element Observation.value[x] is missing.",
"comment" : "Null or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be \"detected\", \"not detected\", \"inconclusive\", or \"specimen unsatisfactory\". \n\nThe alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values. For example, the dataAbsentReason code \"error\" could be used when the measurement was not completed. Note that an observation may only be reported if there are values to report. For example differential cell counts values may be reported only when > 0. Because of these options, use-case agreements are required to interpret general observations for null or exceptional values.",
"requirements" : "For many results it is necessary to handle exceptional values in measurements.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Observation.dataAbsentReason",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"condition" : ["obs-6"],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ObservationValueAbsentReason"
}],
"strength" : "extensible",
"description" : "Codes specifying why the result (`Observation.value[x]`) is missing.",
"valueSet" : "http://hl7.org/fhir/ValueSet/data-absent-reason"
},
"mapping" : [{
"identity" : "v2",
"map" : "N/A"
},
{
"identity" : "rim",
"map" : "value.nullFlavor"
}]
},
{
"id" : "Observation.interpretation",
"path" : "Observation.interpretation",
"short" : "High, low, normal, etc.",
"definition" : "A categorical assessment of an observation value. For example, high, low, normal.",
"comment" : "Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result.",
"requirements" : "For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.",
"alias" : ["Abnormal Flag"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Observation.interpretation",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ObservationInterpretation"
}],
"strength" : "extensible",
"description" : "Codes identifying interpretations of observations.",
"valueSet" : "http://hl7.org/fhir/ValueSet/observation-interpretation"
},
"mapping" : [{
"identity" : "sct-concept",
"map" : "< 260245000 |Findings values|"
},
{
"identity" : "v2",
"map" : "OBX-8"
},
{
"identity" : "rim",
"map" : "interpretationCode"
},
{
"identity" : "sct-attr",
"map" : "363713009 |Has interpretation|"
}]
},
{
"id" : "Observation.note",
"path" : "Observation.note",
"short" : "Comments about the observation",
"definition" : "Comments about the observation or the results.",
"comment" : "May include general statements about the observation, or statements about significant, unexpected or unreliable results values, or information about its source when relevant to its interpretation.",
"requirements" : "Need to be able to provide free text additional information.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Observation.note",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Annotation"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "NTE.3 (partner NTE to OBX, or sometimes another (child?) OBX)"
},
{
"identity" : "rim",
"map" : "subjectOf.observationEvent[code=\"annotation\"].value"
}]
},
{
"id" : "Observation.bodySite",
"path" : "Observation.bodySite",
"short" : "Observed body part",
"definition" : "Indicates the site on the subject's body where the observation was made (i.e. the target site).",
"comment" : "Only used if not implicit in code found in Observation.code. In many systems, this may be represented as a related observation instead of an inline component. \n\nIf the use case requires BodySite to be handled as a separate resource (e.g. to identify and track separately) then use the standard extension[ bodySite](extension-bodysite.html).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Observation.bodySite",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "BodySite"
}],
"strength" : "example",
"description" : "Codes describing anatomical locations. May include laterality.",
"valueSet" : "http://hl7.org/fhir/ValueSet/body-site"
},
"mapping" : [{
"identity" : "sct-concept",
"map" : "< 123037004 |Body structure|"
},
{
"identity" : "v2",
"map" : "OBX-20"
},
{
"identity" : "rim",
"map" : "targetSiteCode"
},
{
"identity" : "sct-attr",
"map" : "718497002 |Inherent location|"
}]
},
{
"id" : "Observation.method",
"path" : "Observation.method",
"short" : "How it was done",
"definition" : "Indicates the mechanism used to perform the observation.",
"comment" : "Only used if not implicit in code for Observation.code.",
"requirements" : "In some cases, method can impact results and is thus used for determining whether results can be compared or determining significance of results.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Observation.method",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ObservationMethod"
}],
"strength" : "example",
"description" : "Methods for simple observations.",
"valueSet" : "http://hl7.org/fhir/ValueSet/observation-methods"
},
"mapping" : [{
"identity" : "v2",
"map" : "OBX-17"
},
{
"identity" : "rim",
"map" : "methodCode"
}]
},
{
"id" : "Observation.specimen",
"path" : "Observation.specimen",
"short" : "Specimen used for this observation",
"definition" : "The specimen that was used when this observation was made.",
"comment" : "Should only be used if not implicit in code found in `Observation.code`. Observations are not made on specimens themselves; they are made on a subject, but in many cases by the means of a specimen. Note that although specimens are often involved, they are not always tracked and reported explicitly. Also note that observation resources may be used in contexts that track the specimen explicitly (e.g. Diagnostic Report).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Observation.specimen",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Specimen"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "sct-concept",
"map" : "< 123038009 |Specimen|"
},
{
"identity" : "v2",
"map" : "SPM segment"
},
{
"identity" : "rim",
"map" : "participation[typeCode=SPC].specimen"
},
{
"identity" : "sct-attr",
"map" : "704319004 |Inherent in|"
}]
},
{
"id" : "Observation.device",
"path" : "Observation.device",
"short" : "(Measurement) Device",
"definition" : "The device used to generate the observation data.",
"comment" : "Note that this is not meant to represent a device involved in the transmission of the result, e.g., a gateway. Such devices may be documented using the Provenance resource where relevant.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Observation.device",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Device",
"http://hl7.org/fhir/StructureDefinition/DeviceMetric"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "sct-concept",
"map" : "< 49062001 |Device|"
},
{
"identity" : "v2",
"map" : "OBX-17 / PRT -10"
},
{
"identity" : "rim",
"map" : "participation[typeCode=DEV]"
},
{
"identity" : "sct-attr",
"map" : "424226004 |Using device|"
}]
},
{
"id" : "Observation.referenceRange",
"path" : "Observation.referenceRange",
"short" : "Provides guide for interpretation",
"definition" : "Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an \"OR\". In other words, to represent two distinct target populations, two `referenceRange` elements would be used.",
"comment" : "Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this might not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.",
"requirements" : "Knowing what values are considered \"normal\" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Observation.referenceRange",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "obs-3",
"severity" : "error",
"human" : "Must have at least a low or a high or text",
"expression" : "low.exists() or high.exists() or text.exists()",
"xpath" : "(exists(f:low) or exists(f:high)or exists(f:text))"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "OBX.7"
},
{
"identity" : "rim",
"map" : "outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]"
}]
},
{
"id" : "Observation.referenceRange.id",
"path" : "Observation.referenceRange.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Observation.referenceRange.extension",
"path" : "Observation.referenceRange.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Observation.referenceRange.modifierExtension",
"path" : "Observation.referenceRange.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Observation.referenceRange.low",
"path" : "Observation.referenceRange.low",
"short" : "Low Range, if relevant",
"definition" : "The value of the low bound of the reference range. The low bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the low bound is omitted, it is assumed to be meaningless (e.g. reference range is <=2.3).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Observation.referenceRange.low",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Quantity",
"profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
}],
"condition" : ["obs-3"],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "OBX-7"
},
{
"identity" : "rim",
"map" : "value:IVL_PQ.low"
}]
},
{
"id" : "Observation.referenceRange.high",
"path" : "Observation.referenceRange.high",
"short" : "High Range, if relevant",
"definition" : "The value of the high bound of the reference range. The high bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the high bound is omitted, it is assumed to be meaningless (e.g. reference range is >= 2.3).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Observation.referenceRange.high",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Quantity",
"profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
}],
"condition" : ["obs-3"],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "OBX-7"
},
{
"identity" : "rim",
"map" : "value:IVL_PQ.high"
}]
},
{
"id" : "Observation.referenceRange.type",
"path" : "Observation.referenceRange.type",
"short" : "Reference range qualifier",
"definition" : "Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range.",
"comment" : "This SHOULD be populated if there is more than one range. If this element is not present then the normal range is assumed.",
"requirements" : "Need to be able to say what kind of reference range this is - normal, recommended, therapeutic, etc., - for proper interpretation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Observation.referenceRange.type",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ObservationRangeMeaning"
}],
"strength" : "preferred",
"description" : "Code for the meaning of a reference range.",
"valueSet" : "http://hl7.org/fhir/ValueSet/referencerange-meaning"
},
"mapping" : [{
"identity" : "sct-concept",
"map" : "< 260245000 |Findings values| OR \r< 365860008 |General clinical state finding| \rOR \r< 250171008 |Clinical history or observation findings| OR \r< 415229000 |Racial group| OR \r< 365400002 |Finding of puberty stage| OR\r< 443938003 |Procedure carried out on subject|"
},
{
"identity" : "v2",
"map" : "OBX-10"
},
{
"identity" : "rim",
"map" : "interpretationCode"
}]
},
{
"id" : "Observation.referenceRange.appliesTo",
"path" : "Observation.referenceRange.appliesTo",
"short" : "Reference range population",
"definition" : "Codes to indicate the target population this reference range applies to. For example, a reference range may be based on the normal population or a particular sex or race. Multiple `appliesTo` are interpreted as an \"AND\" of the target populations. For example, to represent a target population of African American females, both a code of female and a code for African American would be used.",
"comment" : "This SHOULD be populated if there is more than one range. If this element is not present then the normal population is assumed.",
"requirements" : "Need to be able to identify the target population for proper interpretation.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Observation.referenceRange.appliesTo",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ObservationRangeType"
}],
"strength" : "example",
"description" : "Codes identifying the population the reference range applies to.",
"valueSet" : "http://hl7.org/fhir/ValueSet/referencerange-appliesto"
},
"mapping" : [{
"identity" : "sct-concept",
"map" : "< 260245000 |Findings values| OR \r< 365860008 |General clinical state finding| \rOR \r< 250171008 |Clinical history or observation findings| OR \r< 415229000 |Racial group| OR \r< 365400002 |Finding of puberty stage| OR\r< 443938003 |Procedure carried out on subject|"
},
{
"identity" : "v2",
"map" : "OBX-10"
},
{
"identity" : "rim",
"map" : "interpretationCode"
}]
},
{
"id" : "Observation.referenceRange.age",
"path" : "Observation.referenceRange.age",
"short" : "Applicable age range, if relevant",
"definition" : "The age at which this reference range is applicable. This is a neonatal age (e.g. number of weeks at term) if the meaning says so.",
"requirements" : "Some analytes vary greatly over age.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Observation.referenceRange.age",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Range"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "outboundRelationship[typeCode=PRCN].targetObservationCriterion[code=\"age\"].value"
}]
},
{
"id" : "Observation.referenceRange.text",
"path" : "Observation.referenceRange.text",
"short" : "Text based reference range in an observation",
"definition" : "Text based reference range in an observation which may be used when a quantitative range is not appropriate for an observation. An example would be a reference value of \"Negative\" or a list or table of \"normals\".",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Observation.referenceRange.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "OBX-7"
},
{
"identity" : "rim",
"map" : "value:ST"
}]
},
{
"id" : "Observation.hasMember",
"path" : "Observation.hasMember",
"short" : "Related resource that belongs to the Observation group",
"definition" : "This observation is a group observation (e.g. a battery, a panel of tests, a set of vital sign measurements) that includes the target as a member of the group.",
"comment" : "When using this element, an observation will typically have either a value or a set of related resources, although both may be present in some cases. For a discussion on the ways Observations can assembled in groups together, see [Notes](observation.html#obsgrouping) below. Note that a system may calculate results from [QuestionnaireResponse](questionnaireresponse.html) into a final score and represent the score as an Observation.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Observation.hasMember",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Observation",
"http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse",
"http://hl7.org/fhir/StructureDefinition/MolecularSequence"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "v2",
"map" : "Relationships established by OBX-4 usage"
},
{
"identity" : "rim",
"map" : "outBoundRelationship"
}]
},
{
"id" : "Observation.derivedFrom",
"path" : "Observation.derivedFrom",
"short" : "Related measurements the observation is made from",
"definition" : "The target resource that represents a measurement from which this observation value is derived. For example, a calculated anion gap or a fetal measurement based on an ultrasound image.",
"comment" : "All the reference choices that are listed in this element can represent clinical observations and other measurements that may be the source for a derived value. The most common reference will be another Observation. For a discussion on the ways Observations can assembled in groups together, see [Notes](observation.html#obsgrouping) below.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Observation.derivedFrom",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/DocumentReference",
"http://hl7.org/fhir/StructureDefinition/ImagingStudy",
"http://hl7.org/fhir/StructureDefinition/Media",
"http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse",
"http://hl7.org/fhir/StructureDefinition/Observation",
"http://hl7.org/fhir/StructureDefinition/MolecularSequence"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "v2",
"map" : "Relationships established by OBX-4 usage"
},
{
"identity" : "rim",
"map" : ".targetObservation"
}]
},
{
"id" : "Observation.component",
"path" : "Observation.component",
"short" : "Component results",
"definition" : "Some observations have multiple component observations. These component observations are expressed as separate code value pairs that share the same attributes. Examples include systolic and diastolic component observations for blood pressure measurement and multiple component observations for genetics observations.",
"comment" : "For a discussion on the ways Observations can be assembled in groups together see [Notes](observation.html#notes) below.",
"requirements" : "Component observations share the same attributes in the Observation resource as the primary observation and are always treated a part of a single observation (they are not separable). However, the reference range for the primary observation value is not inherited by the component values and is required when appropriate for each component observation.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Observation.component",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "v2",
"map" : "containment by OBX-4?"
},
{
"identity" : "rim",
"map" : "outBoundRelationship[typeCode=COMP]"
}]
},
{
"id" : "Observation.component.id",
"path" : "Observation.component.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Observation.component.extension",
"path" : "Observation.component.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Observation.component.modifierExtension",
"path" : "Observation.component.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Observation.component.code",
"path" : "Observation.component.code",
"short" : "Type of component observation (code / type)",
"definition" : "Describes what was observed. Sometimes this is called the observation \"code\".",
"comment" : "*All* code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.",
"requirements" : "Knowing what kind of observation is being made is essential to understanding the observation.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Observation.component.code",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ObservationCode"
}],
"strength" : "example",
"description" : "Codes identifying names of simple observations.",
"valueSet" : "http://hl7.org/fhir/ValueSet/observation-codes"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.what[x]"
},
{
"identity" : "sct-concept",
"map" : "< 363787002 |Observable entity| OR \r< 386053000 |Evaluation procedure|"
},
{
"identity" : "v2",
"map" : "OBX-3"
},
{
"identity" : "rim",
"map" : "code"
}]
},
{
"id" : "Observation.component.value[x]",
"path" : "Observation.component.value[x]",
"short" : "Actual component result",
"definition" : "The information determined as a result of making the observation, if the information has a simple value.",
"comment" : "Used when observation has a set of component observations. An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was derived). If a value is present, the datatype for this element should be determined by Observation.code. A CodeableConcept with just a text would be used instead of a string if the field was usually coded, or if the type associated with the Observation.code defines a coded value. For additional guidance, see the [Notes section](observation.html#notes) below.",
"requirements" : "An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Observation.component.value[x]",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Quantity"
},
{
"code" : "CodeableConcept"
},
{
"code" : "string"
},
{
"code" : "boolean"
},
{
"code" : "integer"
},
{
"code" : "Range"
},
{
"code" : "Ratio"
},
{
"code" : "SampledData"
},
{
"code" : "time"
},
{
"code" : "dateTime"
},
{
"code" : "Period"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "sct-concept",
"map" : "363714003 |Interprets| < 441742003 |Evaluation finding|"
},
{
"identity" : "v2",
"map" : "OBX.2, OBX.5, OBX.6"
},
{
"identity" : "rim",
"map" : "value"
},
{
"identity" : "sct-attr",
"map" : "363714003 |Interprets|"
}]
},
{
"id" : "Observation.component.dataAbsentReason",
"path" : "Observation.component.dataAbsentReason",
"short" : "Why the component result is missing",
"definition" : "Provides a reason why the expected value in the element Observation.component.value[x] is missing.",
"comment" : "\"Null\" or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be \"detected\", \"not detected\", \"inconclusive\", or \"test not done\". \n\nThe alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values. For example, the dataAbsentReason code \"error\" could be used when the measurement was not completed. Because of these options, use-case agreements are required to interpret general observations for exceptional values.",
"requirements" : "For many results it is necessary to handle exceptional values in measurements.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Observation.component.dataAbsentReason",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"condition" : ["obs-6"],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ObservationValueAbsentReason"
}],
"strength" : "extensible",
"description" : "Codes specifying why the result (`Observation.value[x]`) is missing.",
"valueSet" : "http://hl7.org/fhir/ValueSet/data-absent-reason"
},
"mapping" : [{
"identity" : "v2",
"map" : "N/A"
},
{
"identity" : "rim",
"map" : "value.nullFlavor"
}]
},
{
"id" : "Observation.component.interpretation",
"path" : "Observation.component.interpretation",
"short" : "High, low, normal, etc.",
"definition" : "A categorical assessment of an observation value. For example, high, low, normal.",
"comment" : "Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result.",
"requirements" : "For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.",
"alias" : ["Abnormal Flag"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Observation.component.interpretation",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ObservationInterpretation"
}],
"strength" : "extensible",
"description" : "Codes identifying interpretations of observations.",
"valueSet" : "http://hl7.org/fhir/ValueSet/observation-interpretation"
},
"mapping" : [{
"identity" : "sct-concept",
"map" : "< 260245000 |Findings values|"
},
{
"identity" : "v2",
"map" : "OBX-8"
},
{
"identity" : "rim",
"map" : "interpretationCode"
},
{
"identity" : "sct-attr",
"map" : "363713009 |Has interpretation|"
}]
},
{
"id" : "Observation.component.referenceRange",
"path" : "Observation.component.referenceRange",
"short" : "Provides guide for interpretation of component result",
"definition" : "Guidance on how to interpret the value by comparison to a normal or recommended range.",
"comment" : "Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this might not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.",
"requirements" : "Knowing what values are considered \"normal\" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Observation.component.referenceRange",
"min" : 0,
"max" : "*"
},
"contentReference" : "#Observation.referenceRange",
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "OBX.7"
},
{
"identity" : "rim",
"map" : "outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]"
}]
}]
},
"differential" : {
"element" : [{
"id" : "Observation",
"path" : "Observation",
"short" : "Measurements and simple assertions",
"definition" : "Measurements and simple assertions made about a patient, device or other subject.",
"comment" : "Used for simple observations such as device measurements, laboratory atomic results, vital signs, height, weight, smoking status, comments, etc. Other resources are used to provide context for observations such as laboratory reports, etc.",
"alias" : ["Vital Signs",
"Measurement",
"Results",
"Tests"],
"min" : 0,
"max" : "*",
"constraint" : [{
"key" : "obs-7",
"severity" : "error",
"human" : "If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present",
"expression" : "value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()",
"xpath" : "not(f:*[starts-with(local-name(.), 'value')] and (for $coding in f:code/f:coding return f:component/f:code/f:coding[f:code/@value=$coding/f:code/@value] [f:system/@value=$coding/f:system/@value]))"
},
{
"key" : "obs-6",
"severity" : "error",
"human" : "dataAbsentReason SHALL only be present if Observation.value[x] is not present",
"expression" : "dataAbsentReason.empty() or value.empty()",
"xpath" : "not(exists(f:dataAbsentReason)) or (not(exists(*[starts-with(local-name(.), 'value')])))"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Event"
},
{
"identity" : "sct-concept",
"map" : "< 363787002 |Observable entity|"
},
{
"identity" : "v2",
"map" : "OBX"
},
{
"identity" : "rim",
"map" : "Observation[classCode=OBS, moodCode=EVN]"
}]
},
{
"id" : "Observation.identifier",
"path" : "Observation.identifier",
"short" : "Business Identifier for observation",
"definition" : "A unique identifier assigned to this observation.",
"requirements" : "Allows observations to be distinguished and referenced.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Identifier"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.identifier"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "v2",
"map" : "OBX.21 For OBX segments from systems without OBX-21 support a combination of ORC/OBR and OBX must be negotiated between trading partners to uniquely identify the OBX segment. Depending on how V2 has been implemented each of these may be an option: 1) OBR-3 + OBX-3 + OBX-4 or 2) OBR-3 + OBR-4 + OBX-3 + OBX-4 or 2) some other way to uniquely ID the OBR/ORC + OBX-3 + OBX-4."
},
{
"identity" : "rim",
"map" : "id"
}]
},
{
"id" : "Observation.basedOn",
"path" : "Observation.basedOn",
"short" : "Fulfills plan, proposal or order",
"definition" : "A plan, proposal or order that is fulfilled in whole or in part by this event. For example, a MedicationRequest may require a patient to have laboratory test performed before it is dispensed.",
"requirements" : "Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon.",
"alias" : ["Fulfills"],
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/CarePlan",
"http://hl7.org/fhir/StructureDefinition/DeviceRequest",
"http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation",
"http://hl7.org/fhir/StructureDefinition/MedicationRequest",
"http://hl7.org/fhir/StructureDefinition/NutritionOrder",
"http://hl7.org/fhir/StructureDefinition/ServiceRequest"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.basedOn"
},
{
"identity" : "v2",
"map" : "ORC"
},
{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=COMP].source[moodCode=EVN]"
}]
},
{
"id" : "Observation.partOf",
"path" : "Observation.partOf",
"short" : "Part of referenced event",
"definition" : "A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.",
"comment" : "To link an Observation to an Encounter use `encounter`. See the [Notes](observation.html#obsgrouping) below for guidance on referencing another Observation.",
"alias" : ["Container"],
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/MedicationAdministration",
"http://hl7.org/fhir/StructureDefinition/MedicationDispense",
"http://hl7.org/fhir/StructureDefinition/MedicationStatement",
"http://hl7.org/fhir/StructureDefinition/Procedure",
"http://hl7.org/fhir/StructureDefinition/Immunization",
"http://hl7.org/fhir/StructureDefinition/ImagingStudy"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.partOf"
},
{
"identity" : "v2",
"map" : "Varies by domain"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=FLFS].target"
}]
},
{
"id" : "Observation.status",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-display-hint",
"valueString" : "default: final"
}],
"path" : "Observation.status",
"short" : "registered | preliminary | final | amended +",
"definition" : "The status of the result value.",
"comment" : "This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.",
"requirements" : "Need to track the status of individual results. Some results are finalized before the whole report is finalized.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ObservationStatus"
}],
"strength" : "required",
"description" : "Codes providing the status of an observation.",
"valueSet" : "http://hl7.org/fhir/ValueSet/observation-status|4.0.1"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.status"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
},
{
"identity" : "sct-concept",
"map" : "< 445584004 |Report by finality status|"
},
{
"identity" : "v2",
"map" : "OBX-11"
},
{
"identity" : "rim",
"map" : "status Amended & Final are differentiated by whether it is the subject of a ControlAct event with a type of \"revise\""
}]
},
{
"id" : "Observation.category",
"path" : "Observation.category",
"short" : "Classification of type of observation",
"definition" : "A code that classifies the general type of observation being made.",
"comment" : "In addition to the required category valueset, this element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used at once. The level of granularity is defined by the category concepts in the value set.",
"requirements" : "Used for filtering what observations are retrieved and displayed.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ObservationCategory"
}],
"strength" : "preferred",
"description" : "Codes for high level observation categories.",
"valueSet" : "http://hl7.org/fhir/ValueSet/observation-category"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.class"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=\"COMP].target[classCode=\"LIST\", moodCode=\"EVN\"].code"
}]
},
{
"id" : "Observation.code",
"path" : "Observation.code",
"short" : "Type of observation (code / type)",
"definition" : "Describes what was observed. Sometimes this is called the observation \"name\".",
"comment" : "*All* code-value and, if present, component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.",
"requirements" : "Knowing what kind of observation is being made is essential to understanding the observation.",
"alias" : ["Name"],
"min" : 1,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ObservationCode"
}],
"strength" : "example",
"description" : "Codes identifying names of simple observations.",
"valueSet" : "http://hl7.org/fhir/ValueSet/observation-codes"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.code"
},
{
"identity" : "w5",
"map" : "FiveWs.what[x]"
},
{
"identity" : "sct-concept",
"map" : "< 363787002 |Observable entity| OR < 386053000 |Evaluation procedure|"
},
{
"identity" : "v2",
"map" : "OBX-3"
},
{
"identity" : "rim",
"map" : "code"
},
{
"identity" : "sct-attr",
"map" : "116680003 |Is a|"
}]
},
{
"id" : "Observation.subject",
"path" : "Observation.subject",
"short" : "Who and/or what the observation is about",
"definition" : "The patient, or group of patients, location, or device this observation is about and into whose record the observation is placed. If the actual focus of the observation is different from the subject (or a sample of, part, or region of the subject), the `focus` element or the `code` itself specifies the actual focus of the observation.",
"comment" : "One would expect this element to be a cardinality of 1..1. The only circumstance in which the subject can be missing is when the observation is made by a device that does not know the patient. In this case, the observation SHALL be matched to a patient through some context/channel matching technique, and at this point, the observation should be updated.",
"requirements" : "Observations have no value if you don't know who or what they're about.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Group",
"http://hl7.org/fhir/StructureDefinition/Device",
"http://hl7.org/fhir/StructureDefinition/Location"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.subject"
},
{
"identity" : "w5",
"map" : "FiveWs.subject[x]"
},
{
"identity" : "v2",
"map" : "PID-3"
},
{
"identity" : "rim",
"map" : "participation[typeCode=RTGT] "
},
{
"identity" : "w5",
"map" : "FiveWs.subject"
}]
},
{
"id" : "Observation.focus",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"path" : "Observation.focus",
"short" : "What the observation is about, when it is not about the subject of record",
"definition" : "The actual focus of an observation when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, fetus, or donor. For example, fetus observations in a mother's record. The focus of an observation could also be an existing condition, an intervention, the subject's diet, another observation of the subject, or a body structure such as tumor or implanted device. An example use case would be using the Observation resource to capture whether the mother is trained to change her child's tracheostomy tube. In this example, the child is the patient of record and the mother is the focus.",
"comment" : "Typically, an observation is made about the subject - a patient, or group of patients, location, or device - and the distinction between the subject and what is directly measured for an observation is specified in the observation code itself ( e.g., \"Blood Glucose\") and does not need to be represented separately using this element. Use `specimen` if a reference to a specimen is required. If a code is required instead of a resource use either `bodysite` for bodysites or the standard extension [focusCode](extension-observation-focuscode.html).",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.subject[x]"
},
{
"identity" : "v2",
"map" : "OBX-3"
},
{
"identity" : "rim",
"map" : "participation[typeCode=SBJ]"
},
{
"identity" : "w5",
"map" : "FiveWs.subject"
}]
},
{
"id" : "Observation.encounter",
"path" : "Observation.encounter",
"short" : "Healthcare event during which this observation is made",
"definition" : "The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.",
"comment" : "This will typically be the encounter the event occurred within, but some events may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter (e.g. pre-admission laboratory tests).",
"requirements" : "For some observations it may be important to know the link between an observation and a particular encounter.",
"alias" : ["Context"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Encounter"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.context"
},
{
"identity" : "w5",
"map" : "FiveWs.context"
},
{
"identity" : "v2",
"map" : "PV1"
},
{
"identity" : "rim",
"map" : "inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN]"
}]
},
{
"id" : "Observation.effective[x]",
"path" : "Observation.effective[x]",
"short" : "Clinically relevant time/time-period for observation",
"definition" : "The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the \"physiologically relevant time\". This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.",
"comment" : "At least a date should be present unless this observation is a historical report. For recording imprecise or \"fuzzy\" times (For example, a blood glucose measurement taken \"after breakfast\") use the [Timing](datatypes.html#timing) datatype which allow the measurement to be tied to regular life events.",
"requirements" : "Knowing when an observation was deemed true is important to its relevance as well as determining trends.",
"alias" : ["Occurrence"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "dateTime"
},
{
"code" : "Period"
},
{
"code" : "Timing"
},
{
"code" : "instant"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.occurrence[x]"
},
{
"identity" : "w5",
"map" : "FiveWs.done[x]"
},
{
"identity" : "v2",
"map" : "OBX-14, and/or OBX-19 after v2.4 (depends on who observation made)"
},
{
"identity" : "rim",
"map" : "effectiveTime"
}]
},
{
"id" : "Observation.issued",
"path" : "Observation.issued",
"short" : "Date/Time this version was made available",
"definition" : "The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified.",
"comment" : "For Observations that don’t require review and verification, it may be the same as the [`lastUpdated` ](resource-definitions.html#Meta.lastUpdated) time of the resource itself. For Observations that do require review and verification for certain updates, it might not be the same as the `lastUpdated` time of the resource itself due to a non-clinically significant update that doesn’t require the new version to be reviewed and verified again.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "instant"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.recorded"
},
{
"identity" : "v2",
"map" : "OBR.22 (or MSH.7), or perhaps OBX-19 (depends on who observation made)"
},
{
"identity" : "rim",
"map" : "participation[typeCode=AUT].time"
}]
},
{
"id" : "Observation.performer",
"path" : "Observation.performer",
"short" : "Who is responsible for the observation",
"definition" : "Who was responsible for asserting the observed value as \"true\".",
"requirements" : "May give a degree of confidence in the observation and also indicates where follow-up questions should be directed.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Organization",
"http://hl7.org/fhir/StructureDefinition/CareTeam",
"http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.performer.actor"
},
{
"identity" : "w5",
"map" : "FiveWs.actor"
},
{
"identity" : "v2",
"map" : "OBX.15 / (Practitioner) OBX-16, PRT-5:PRT-4='RO' / (Device) OBX-18 , PRT-10:PRT-4='EQUIP' / (Organization) OBX-23, PRT-8:PRT-4='PO'"
},
{
"identity" : "rim",
"map" : "participation[typeCode=PRF]"
}]
},
{
"id" : "Observation.value[x]",
"path" : "Observation.value[x]",
"short" : "Actual result",
"definition" : "The information determined as a result of making the observation, if the information has a simple value.",
"comment" : "An observation may have; 1) a single value here, 2) both a value and a set of related or component values, or 3) only a set of related or component values. If a value is present, the datatype for this element should be determined by Observation.code. A CodeableConcept with just a text would be used instead of a string if the field was usually coded, or if the type associated with the Observation.code defines a coded value. For additional guidance, see the [Notes section](observation.html#notes) below.",
"requirements" : "An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Quantity"
},
{
"code" : "CodeableConcept"
},
{
"code" : "string"
},
{
"code" : "boolean"
},
{
"code" : "integer"
},
{
"code" : "Range"
},
{
"code" : "Ratio"
},
{
"code" : "SampledData"
},
{
"code" : "time"
},
{
"code" : "dateTime"
},
{
"code" : "Period"
}],
"condition" : ["obs-7"],
"isSummary" : true,
"mapping" : [{
"identity" : "sct-concept",
"map" : "< 441742003 |Evaluation finding|"
},
{
"identity" : "v2",
"map" : "OBX.2, OBX.5, OBX.6"
},
{
"identity" : "rim",
"map" : "value"
},
{
"identity" : "sct-attr",
"map" : "363714003 |Interprets|"
}]
},
{
"id" : "Observation.dataAbsentReason",
"path" : "Observation.dataAbsentReason",
"short" : "Why the result is missing",
"definition" : "Provides a reason why the expected value in the element Observation.value[x] is missing.",
"comment" : "Null or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be \"detected\", \"not detected\", \"inconclusive\", or \"specimen unsatisfactory\". \n\nThe alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values. For example, the dataAbsentReason code \"error\" could be used when the measurement was not completed. Note that an observation may only be reported if there are values to report. For example differential cell counts values may be reported only when > 0. Because of these options, use-case agreements are required to interpret general observations for null or exceptional values.",
"requirements" : "For many results it is necessary to handle exceptional values in measurements.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"condition" : ["obs-6"],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ObservationValueAbsentReason"
}],
"strength" : "extensible",
"description" : "Codes specifying why the result (`Observation.value[x]`) is missing.",
"valueSet" : "http://hl7.org/fhir/ValueSet/data-absent-reason"
},
"mapping" : [{
"identity" : "v2",
"map" : "N/A"
},
{
"identity" : "rim",
"map" : "value.nullFlavor"
}]
},
{
"id" : "Observation.interpretation",
"path" : "Observation.interpretation",
"short" : "High, low, normal, etc.",
"definition" : "A categorical assessment of an observation value. For example, high, low, normal.",
"comment" : "Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result.",
"requirements" : "For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.",
"alias" : ["Abnormal Flag"],
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ObservationInterpretation"
}],
"strength" : "extensible",
"description" : "Codes identifying interpretations of observations.",
"valueSet" : "http://hl7.org/fhir/ValueSet/observation-interpretation"
},
"mapping" : [{
"identity" : "sct-concept",
"map" : "< 260245000 |Findings values|"
},
{
"identity" : "v2",
"map" : "OBX-8"
},
{
"identity" : "rim",
"map" : "interpretationCode"
},
{
"identity" : "sct-attr",
"map" : "363713009 |Has interpretation|"
}]
},
{
"id" : "Observation.note",
"path" : "Observation.note",
"short" : "Comments about the observation",
"definition" : "Comments about the observation or the results.",
"comment" : "May include general statements about the observation, or statements about significant, unexpected or unreliable results values, or information about its source when relevant to its interpretation.",
"requirements" : "Need to be able to provide free text additional information.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Annotation"
}],
"mapping" : [{
"identity" : "v2",
"map" : "NTE.3 (partner NTE to OBX, or sometimes another (child?) OBX)"
},
{
"identity" : "rim",
"map" : "subjectOf.observationEvent[code=\"annotation\"].value"
}]
},
{
"id" : "Observation.bodySite",
"path" : "Observation.bodySite",
"short" : "Observed body part",
"definition" : "Indicates the site on the subject's body where the observation was made (i.e. the target site).",
"comment" : "Only used if not implicit in code found in Observation.code. In many systems, this may be represented as a related observation instead of an inline component. \n\nIf the use case requires BodySite to be handled as a separate resource (e.g. to identify and track separately) then use the standard extension[ bodySite](extension-bodysite.html).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "BodySite"
}],
"strength" : "example",
"description" : "Codes describing anatomical locations. May include laterality.",
"valueSet" : "http://hl7.org/fhir/ValueSet/body-site"
},
"mapping" : [{
"identity" : "sct-concept",
"map" : "< 123037004 |Body structure|"
},
{
"identity" : "v2",
"map" : "OBX-20"
},
{
"identity" : "rim",
"map" : "targetSiteCode"
},
{
"identity" : "sct-attr",
"map" : "718497002 |Inherent location|"
}]
},
{
"id" : "Observation.method",
"path" : "Observation.method",
"short" : "How it was done",
"definition" : "Indicates the mechanism used to perform the observation.",
"comment" : "Only used if not implicit in code for Observation.code.",
"requirements" : "In some cases, method can impact results and is thus used for determining whether results can be compared or determining significance of results.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ObservationMethod"
}],
"strength" : "example",
"description" : "Methods for simple observations.",
"valueSet" : "http://hl7.org/fhir/ValueSet/observation-methods"
},
"mapping" : [{
"identity" : "v2",
"map" : "OBX-17"
},
{
"identity" : "rim",
"map" : "methodCode"
}]
},
{
"id" : "Observation.specimen",
"path" : "Observation.specimen",
"short" : "Specimen used for this observation",
"definition" : "The specimen that was used when this observation was made.",
"comment" : "Should only be used if not implicit in code found in `Observation.code`. Observations are not made on specimens themselves; they are made on a subject, but in many cases by the means of a specimen. Note that although specimens are often involved, they are not always tracked and reported explicitly. Also note that observation resources may be used in contexts that track the specimen explicitly (e.g. Diagnostic Report).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Specimen"]
}],
"mapping" : [{
"identity" : "sct-concept",
"map" : "< 123038009 |Specimen|"
},
{
"identity" : "v2",
"map" : "SPM segment"
},
{
"identity" : "rim",
"map" : "participation[typeCode=SPC].specimen"
},
{
"identity" : "sct-attr",
"map" : "704319004 |Inherent in|"
}]
},
{
"id" : "Observation.device",
"path" : "Observation.device",
"short" : "(Measurement) Device",
"definition" : "The device used to generate the observation data.",
"comment" : "Note that this is not meant to represent a device involved in the transmission of the result, e.g., a gateway. Such devices may be documented using the Provenance resource where relevant.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Device",
"http://hl7.org/fhir/StructureDefinition/DeviceMetric"]
}],
"mapping" : [{
"identity" : "sct-concept",
"map" : "< 49062001 |Device|"
},
{
"identity" : "v2",
"map" : "OBX-17 / PRT -10"
},
{
"identity" : "rim",
"map" : "participation[typeCode=DEV]"
},
{
"identity" : "sct-attr",
"map" : "424226004 |Using device|"
}]
},
{
"id" : "Observation.referenceRange",
"path" : "Observation.referenceRange",
"short" : "Provides guide for interpretation",
"definition" : "Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an \"OR\". In other words, to represent two distinct target populations, two `referenceRange` elements would be used.",
"comment" : "Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this might not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.",
"requirements" : "Knowing what values are considered \"normal\" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "obs-3",
"severity" : "error",
"human" : "Must have at least a low or a high or text",
"expression" : "low.exists() or high.exists() or text.exists()",
"xpath" : "(exists(f:low) or exists(f:high)or exists(f:text))"
}],
"mapping" : [{
"identity" : "v2",
"map" : "OBX.7"
},
{
"identity" : "rim",
"map" : "outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]"
}]
},
{
"id" : "Observation.referenceRange.low",
"path" : "Observation.referenceRange.low",
"short" : "Low Range, if relevant",
"definition" : "The value of the low bound of the reference range. The low bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the low bound is omitted, it is assumed to be meaningless (e.g. reference range is <=2.3).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Quantity",
"profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
}],
"condition" : ["obs-3"],
"mapping" : [{
"identity" : "v2",
"map" : "OBX-7"
},
{
"identity" : "rim",
"map" : "value:IVL_PQ.low"
}]
},
{
"id" : "Observation.referenceRange.high",
"path" : "Observation.referenceRange.high",
"short" : "High Range, if relevant",
"definition" : "The value of the high bound of the reference range. The high bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the high bound is omitted, it is assumed to be meaningless (e.g. reference range is >= 2.3).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Quantity",
"profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
}],
"condition" : ["obs-3"],
"mapping" : [{
"identity" : "v2",
"map" : "OBX-7"
},
{
"identity" : "rim",
"map" : "value:IVL_PQ.high"
}]
},
{
"id" : "Observation.referenceRange.type",
"path" : "Observation.referenceRange.type",
"short" : "Reference range qualifier",
"definition" : "Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range.",
"comment" : "This SHOULD be populated if there is more than one range. If this element is not present then the normal range is assumed.",
"requirements" : "Need to be able to say what kind of reference range this is - normal, recommended, therapeutic, etc., - for proper interpretation.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ObservationRangeMeaning"
}],
"strength" : "preferred",
"description" : "Code for the meaning of a reference range.",
"valueSet" : "http://hl7.org/fhir/ValueSet/referencerange-meaning"
},
"mapping" : [{
"identity" : "sct-concept",
"map" : "< 260245000 |Findings values| OR \r< 365860008 |General clinical state finding| \rOR \r< 250171008 |Clinical history or observation findings| OR \r< 415229000 |Racial group| OR \r< 365400002 |Finding of puberty stage| OR\r< 443938003 |Procedure carried out on subject|"
},
{
"identity" : "v2",
"map" : "OBX-10"
},
{
"identity" : "rim",
"map" : "interpretationCode"
}]
},
{
"id" : "Observation.referenceRange.appliesTo",
"path" : "Observation.referenceRange.appliesTo",
"short" : "Reference range population",
"definition" : "Codes to indicate the target population this reference range applies to. For example, a reference range may be based on the normal population or a particular sex or race. Multiple `appliesTo` are interpreted as an \"AND\" of the target populations. For example, to represent a target population of African American females, both a code of female and a code for African American would be used.",
"comment" : "This SHOULD be populated if there is more than one range. If this element is not present then the normal population is assumed.",
"requirements" : "Need to be able to identify the target population for proper interpretation.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ObservationRangeType"
}],
"strength" : "example",
"description" : "Codes identifying the population the reference range applies to.",
"valueSet" : "http://hl7.org/fhir/ValueSet/referencerange-appliesto"
},
"mapping" : [{
"identity" : "sct-concept",
"map" : "< 260245000 |Findings values| OR \r< 365860008 |General clinical state finding| \rOR \r< 250171008 |Clinical history or observation findings| OR \r< 415229000 |Racial group| OR \r< 365400002 |Finding of puberty stage| OR\r< 443938003 |Procedure carried out on subject|"
},
{
"identity" : "v2",
"map" : "OBX-10"
},
{
"identity" : "rim",
"map" : "interpretationCode"
}]
},
{
"id" : "Observation.referenceRange.age",
"path" : "Observation.referenceRange.age",
"short" : "Applicable age range, if relevant",
"definition" : "The age at which this reference range is applicable. This is a neonatal age (e.g. number of weeks at term) if the meaning says so.",
"requirements" : "Some analytes vary greatly over age.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Range"
}],
"mapping" : [{
"identity" : "rim",
"map" : "outboundRelationship[typeCode=PRCN].targetObservationCriterion[code=\"age\"].value"
}]
},
{
"id" : "Observation.referenceRange.text",
"path" : "Observation.referenceRange.text",
"short" : "Text based reference range in an observation",
"definition" : "Text based reference range in an observation which may be used when a quantitative range is not appropriate for an observation. An example would be a reference value of \"Negative\" or a list or table of \"normals\".",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"mapping" : [{
"identity" : "v2",
"map" : "OBX-7"
},
{
"identity" : "rim",
"map" : "value:ST"
}]
},
{
"id" : "Observation.hasMember",
"path" : "Observation.hasMember",
"short" : "Related resource that belongs to the Observation group",
"definition" : "This observation is a group observation (e.g. a battery, a panel of tests, a set of vital sign measurements) that includes the target as a member of the group.",
"comment" : "When using this element, an observation will typically have either a value or a set of related resources, although both may be present in some cases. For a discussion on the ways Observations can assembled in groups together, see [Notes](observation.html#obsgrouping) below. Note that a system may calculate results from [QuestionnaireResponse](questionnaireresponse.html) into a final score and represent the score as an Observation.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Observation",
"http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse",
"http://hl7.org/fhir/StructureDefinition/MolecularSequence"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "v2",
"map" : "Relationships established by OBX-4 usage"
},
{
"identity" : "rim",
"map" : "outBoundRelationship"
}]
},
{
"id" : "Observation.derivedFrom",
"path" : "Observation.derivedFrom",
"short" : "Related measurements the observation is made from",
"definition" : "The target resource that represents a measurement from which this observation value is derived. For example, a calculated anion gap or a fetal measurement based on an ultrasound image.",
"comment" : "All the reference choices that are listed in this element can represent clinical observations and other measurements that may be the source for a derived value. The most common reference will be another Observation. For a discussion on the ways Observations can assembled in groups together, see [Notes](observation.html#obsgrouping) below.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/DocumentReference",
"http://hl7.org/fhir/StructureDefinition/ImagingStudy",
"http://hl7.org/fhir/StructureDefinition/Media",
"http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse",
"http://hl7.org/fhir/StructureDefinition/Observation",
"http://hl7.org/fhir/StructureDefinition/MolecularSequence"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "v2",
"map" : "Relationships established by OBX-4 usage"
},
{
"identity" : "rim",
"map" : ".targetObservation"
}]
},
{
"id" : "Observation.component",
"path" : "Observation.component",
"short" : "Component results",
"definition" : "Some observations have multiple component observations. These component observations are expressed as separate code value pairs that share the same attributes. Examples include systolic and diastolic component observations for blood pressure measurement and multiple component observations for genetics observations.",
"comment" : "For a discussion on the ways Observations can be assembled in groups together see [Notes](observation.html#notes) below.",
"requirements" : "Component observations share the same attributes in the Observation resource as the primary observation and are always treated a part of a single observation (they are not separable). However, the reference range for the primary observation value is not inherited by the component values and is required when appropriate for each component observation.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "v2",
"map" : "containment by OBX-4?"
},
{
"identity" : "rim",
"map" : "outBoundRelationship[typeCode=COMP]"
}]
},
{
"id" : "Observation.component.code",
"path" : "Observation.component.code",
"short" : "Type of component observation (code / type)",
"definition" : "Describes what was observed. Sometimes this is called the observation \"code\".",
"comment" : "*All* code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.",
"requirements" : "Knowing what kind of observation is being made is essential to understanding the observation.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ObservationCode"
}],
"strength" : "example",
"description" : "Codes identifying names of simple observations.",
"valueSet" : "http://hl7.org/fhir/ValueSet/observation-codes"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.what[x]"
},
{
"identity" : "sct-concept",
"map" : "< 363787002 |Observable entity| OR \r< 386053000 |Evaluation procedure|"
},
{
"identity" : "v2",
"map" : "OBX-3"
},
{
"identity" : "rim",
"map" : "code"
}]
},
{
"id" : "Observation.component.value[x]",
"path" : "Observation.component.value[x]",
"short" : "Actual component result",
"definition" : "The information determined as a result of making the observation, if the information has a simple value.",
"comment" : "Used when observation has a set of component observations. An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was derived). If a value is present, the datatype for this element should be determined by Observation.code. A CodeableConcept with just a text would be used instead of a string if the field was usually coded, or if the type associated with the Observation.code defines a coded value. For additional guidance, see the [Notes section](observation.html#notes) below.",
"requirements" : "An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Quantity"
},
{
"code" : "CodeableConcept"
},
{
"code" : "string"
},
{
"code" : "boolean"
},
{
"code" : "integer"
},
{
"code" : "Range"
},
{
"code" : "Ratio"
},
{
"code" : "SampledData"
},
{
"code" : "time"
},
{
"code" : "dateTime"
},
{
"code" : "Period"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "sct-concept",
"map" : "363714003 |Interprets| < 441742003 |Evaluation finding|"
},
{
"identity" : "v2",
"map" : "OBX.2, OBX.5, OBX.6"
},
{
"identity" : "rim",
"map" : "value"
},
{
"identity" : "sct-attr",
"map" : "363714003 |Interprets|"
}]
},
{
"id" : "Observation.component.dataAbsentReason",
"path" : "Observation.component.dataAbsentReason",
"short" : "Why the component result is missing",
"definition" : "Provides a reason why the expected value in the element Observation.component.value[x] is missing.",
"comment" : "\"Null\" or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be \"detected\", \"not detected\", \"inconclusive\", or \"test not done\". \n\nThe alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values. For example, the dataAbsentReason code \"error\" could be used when the measurement was not completed. Because of these options, use-case agreements are required to interpret general observations for exceptional values.",
"requirements" : "For many results it is necessary to handle exceptional values in measurements.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"condition" : ["obs-6"],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ObservationValueAbsentReason"
}],
"strength" : "extensible",
"description" : "Codes specifying why the result (`Observation.value[x]`) is missing.",
"valueSet" : "http://hl7.org/fhir/ValueSet/data-absent-reason"
},
"mapping" : [{
"identity" : "v2",
"map" : "N/A"
},
{
"identity" : "rim",
"map" : "value.nullFlavor"
}]
},
{
"id" : "Observation.component.interpretation",
"path" : "Observation.component.interpretation",
"short" : "High, low, normal, etc.",
"definition" : "A categorical assessment of an observation value. For example, high, low, normal.",
"comment" : "Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result.",
"requirements" : "For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.",
"alias" : ["Abnormal Flag"],
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ObservationInterpretation"
}],
"strength" : "extensible",
"description" : "Codes identifying interpretations of observations.",
"valueSet" : "http://hl7.org/fhir/ValueSet/observation-interpretation"
},
"mapping" : [{
"identity" : "sct-concept",
"map" : "< 260245000 |Findings values|"
},
{
"identity" : "v2",
"map" : "OBX-8"
},
{
"identity" : "rim",
"map" : "interpretationCode"
},
{
"identity" : "sct-attr",
"map" : "363713009 |Has interpretation|"
}]
},
{
"id" : "Observation.component.referenceRange",
"path" : "Observation.component.referenceRange",
"short" : "Provides guide for interpretation of component result",
"definition" : "Guidance on how to interpret the value by comparison to a normal or recommended range.",
"comment" : "Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this might not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.",
"requirements" : "Knowing what values are considered \"normal\" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts.",
"min" : 0,
"max" : "*",
"contentReference" : "#Observation.referenceRange",
"mapping" : [{
"identity" : "v2",
"map" : "OBX.7"
},
{
"identity" : "rim",
"map" : "outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]"
}]
}]
}
}
},
{
"fullUrl" : "http://hl7.org/fhir/StructureDefinition/ObservationDefinition",
"resource" : {
"resourceType" : "StructureDefinition",
"id" : "ObservationDefinition",
"meta" : {
"lastUpdated" : "2019-11-01T09:29:23.356+11:00"
},
"text" : {
"status" : "generated",
"div" : "Name Flags Card. Type Description & Constraints ObservationDefinition TU DomainResource Definition of an observation
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension category Σ 0..* CodeableConcept Category of observation
Observation Category Codes (Example)
code Σ 1..1 CodeableConcept Type of observation (code / type)
LOINC Codes (Example) identifier Σ 0..* Identifier Business identifier for this ObservationDefinition instance
permittedDataType 0..* code Quantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period
ObservationDataType (Required)
multipleResultsAllowed 0..1 boolean Multiple results allowed method 0..1 CodeableConcept Method used to produce the observation
Observation Methods (Example) preferredReportName 0..1 string Preferred report name quantitativeDetails 0..1 BackboneElement Characteristics of quantitative results customaryUnit 0..1 CodeableConcept Customary unit for quantitative results
UCUM Codes (Extensible) unit 0..1 CodeableConcept SI unit for quantitative results
UCUM Codes (Extensible) conversionFactor 0..1 decimal SI to Customary unit conversion factor decimalPrecision 0..1 integer Decimal precision of observation quantitative results qualifiedInterval 0..* BackboneElement Qualified range for continuous and ordinal observation results
category 0..1 code reference | critical | absolute
ObservationRangeCategory (Required) range 0..1 Range The interval itself, for continuous or ordinal observations context 0..1 CodeableConcept Range context qualifier
Observation Reference Range Meaning Codes (Extensible) appliesTo 0..* CodeableConcept Targetted population of the range
Observation Reference Range Applies To Codes (Example)
gender 0..1 code male | female | other | unknown
AdministrativeGender (Required) age 0..1 Range Applicable age range, if relevant gestationalAge 0..1 Range Applicable gestational age range, if relevant condition 0..1 string Condition associated with the reference range validCodedValueSet 0..1 Reference(ValueSet) Value set of valid coded values for the observations conforming to this ObservationDefinition normalCodedValueSet 0..1 Reference(ValueSet) Value set of normal coded values for the observations conforming to this ObservationDefinition abnormalCodedValueSet 0..1 Reference(ValueSet) Value set of abnormal coded values for the observations conforming to this ObservationDefinition criticalCodedValueSet 0..1 Reference(ValueSet) Value set of critical coded values for the observations conforming to this ObservationDefinition
Documentation for this format
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Specialized.Definitional Artifacts"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 0
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "business"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "oo"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/ObservationDefinition",
"version" : "4.0.1",
"name" : "ObservationDefinition",
"status" : "draft",
"date" : "2019-11-01T09:29:23+11:00",
"publisher" : "Health Level Seven International (Orders and Observations)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/orders/index.cfm"
}]
}],
"description" : "Set of definitional characteristics for a kind of observation or measurement produced or consumed by an orderable health care service.",
"purpose" : "In a catalog of health-related services that use or produce observations and measurements, this resource describes the expected characteristics of these observation / measurements.",
"fhirVersion" : "4.0.1",
"mapping" : [{
"identity" : "v2",
"uri" : "http://hl7.org/v2",
"name" : "HL7 v2 Mapping"
},
{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/fivews",
"name" : "FiveWs Pattern Mapping"
}],
"kind" : "resource",
"abstract" : false,
"type" : "ObservationDefinition",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "ObservationDefinition",
"path" : "ObservationDefinition",
"short" : "Definition of an observation",
"definition" : "Set of definitional characteristics for a kind of observation or measurement produced or consumed by an orderable health care service.",
"comment" : "An instance of this resource informs the consumer of a health-related service (such as a lab diagnostic test or panel) about how the observations used or produced by this service will look like.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ObservationDefinition",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "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",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.`div`.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "v2",
"map" : "OM2\nOM3\nOMC"
},
{
"identity" : "rim",
"map" : "Observation[classCode=OBS, moodCode=DEF]"
}]
},
{
"id" : "ObservationDefinition.id",
"path" : "ObservationDefinition.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "ObservationDefinition.meta",
"path" : "ObservationDefinition.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "ObservationDefinition.implicitRules",
"path" : "ObservationDefinition.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "ObservationDefinition.language",
"path" : "ObservationDefinition.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "ObservationDefinition.text",
"path" : "ObservationDefinition.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "ObservationDefinition.contained",
"path" : "ObservationDefinition.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ObservationDefinition.extension",
"path" : "ObservationDefinition.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ObservationDefinition.modifierExtension",
"path" : "ObservationDefinition.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ObservationDefinition.publisher",
"path" : "ObservationDefinition.publisher",
"short" : "The name of the individual or organization that published the ObservationDefinition",
"definition" : "Helps establish the \"authority/credibility\" of the ObservationDefinition. May also allow for contact.",
"requirements" : "Usually an organization, but may be an individual. The publisher (or steward) of the ObservationDefinition is the organization or individual primarily responsible for the maintenance and upkeep of the ObservationDefinition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the ObservationDefinition. This item SHOULD be populated unless the information is available from context.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ObservationDefinition.publisher",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}]
},
{
"id" : "ObservationDefinition.category",
"path" : "ObservationDefinition.category",
"short" : "Category of observation",
"definition" : "A code that classifies the general type of observation.",
"comment" : "This element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used for one instance of ObservationDefinition. The level of granularity is defined by the category concepts in the value set.",
"requirements" : "Used for filtering what kinds of observations are retrieved and displayed.",
"alias" : ["Class of observation"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "ObservationDefinition.category",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ObservationCategory"
}],
"strength" : "example",
"description" : "Codes for high level observation categories.",
"valueSet" : "http://hl7.org/fhir/ValueSet/observation-category"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.class"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=\"COMP].target[classCode=\"LIST\", moodCode=\"DEF\"].code"
}]
},
{
"id" : "ObservationDefinition.code",
"path" : "ObservationDefinition.code",
"short" : "Type of observation (code / type)",
"definition" : "Describes what will be observed. Sometimes this is called the observation \"name\".",
"requirements" : "Knowing what kind of observation is being made is essential to understanding the observation.",
"alias" : ["Name"],
"min" : 1,
"max" : "1",
"base" : {
"path" : "ObservationDefinition.code",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ObservationCode"
}],
"strength" : "example",
"description" : "Codes identifying names of simple observations.",
"valueSet" : "http://hl7.org/fhir/ValueSet/observation-codes"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.what[x]"
},
{
"identity" : "v2",
"map" : "OM1-2\nOMC-4"
},
{
"identity" : "rim",
"map" : "code"
}]
},
{
"id" : "ObservationDefinition.identifier",
"path" : "ObservationDefinition.identifier",
"short" : "Business identifier for this ObservationDefinition instance",
"definition" : "A unique identifier assigned to this ObservationDefinition artifact.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ObservationDefinition.identifier",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Identifier"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "ObservationDefinition.permittedDataType",
"path" : "ObservationDefinition.permittedDataType",
"short" : "Quantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period",
"definition" : "The data types allowed for the value element of the instance observations conforming to this ObservationDefinition.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ObservationDefinition.permittedDataType",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "code"
}],
"example" : [{
"label" : "General",
"valueCode" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ObservationDataType"
}],
"strength" : "required",
"description" : "Permitted data type for observation value.",
"valueSet" : "http://hl7.org/fhir/ValueSet/permitted-data-type|4.0.1"
},
"mapping" : [{
"identity" : "v2",
"map" : "OM1-3"
}]
},
{
"id" : "ObservationDefinition.multipleResultsAllowed",
"path" : "ObservationDefinition.multipleResultsAllowed",
"short" : "Multiple results allowed",
"definition" : "Multiple results allowed for observations conforming to this ObservationDefinition.",
"comment" : "An example of observation allowing multiple results is \"bacteria identified by culture\". Conversely, the measurement of a potassium level allows a single result.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ObservationDefinition.multipleResultsAllowed",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"example" : [{
"label" : "General",
"valueBoolean" : true
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ObservationDefinition.method",
"path" : "ObservationDefinition.method",
"short" : "Method used to produce the observation",
"definition" : "The method or technique used to perform the observation.",
"comment" : "Only used if not implicit in observation code.",
"requirements" : "In some cases, method can impact results.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ObservationDefinition.method",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ObservationMethod"
}],
"strength" : "example",
"description" : "Methods for simple observations.",
"valueSet" : "http://hl7.org/fhir/ValueSet/observation-methods"
},
"mapping" : [{
"identity" : "v2",
"map" : "OM1-14"
},
{
"identity" : "rim",
"map" : "methodCode"
}]
},
{
"id" : "ObservationDefinition.preferredReportName",
"path" : "ObservationDefinition.preferredReportName",
"short" : "Preferred report name",
"definition" : "The preferred name to be used when reporting the results of observations conforming to this ObservationDefinition.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ObservationDefinition.preferredReportName",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "OM1-9"
}]
},
{
"id" : "ObservationDefinition.quantitativeDetails",
"path" : "ObservationDefinition.quantitativeDetails",
"short" : "Characteristics of quantitative results",
"definition" : "Characteristics for quantitative results of this observation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ObservationDefinition.quantitativeDetails",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "OM2"
}]
},
{
"id" : "ObservationDefinition.quantitativeDetails.id",
"path" : "ObservationDefinition.quantitativeDetails.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "ObservationDefinition.quantitativeDetails.extension",
"path" : "ObservationDefinition.quantitativeDetails.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "ObservationDefinition.quantitativeDetails.modifierExtension",
"path" : "ObservationDefinition.quantitativeDetails.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ObservationDefinition.quantitativeDetails.customaryUnit",
"path" : "ObservationDefinition.quantitativeDetails.customaryUnit",
"short" : "Customary unit for quantitative results",
"definition" : "Customary unit used to report quantitative results of observations conforming to this ObservationDefinition.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ObservationDefinition.quantitativeDetails.customaryUnit",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ObservationUnit"
}],
"strength" : "extensible",
"description" : "Codes identifying units of measure.",
"valueSet" : "http://hl7.org/fhir/ValueSet/ucum-units"
},
"mapping" : [{
"identity" : "v2",
"map" : "OM2-2"
}]
},
{
"id" : "ObservationDefinition.quantitativeDetails.unit",
"path" : "ObservationDefinition.quantitativeDetails.unit",
"short" : "SI unit for quantitative results",
"definition" : "SI unit used to report quantitative results of observations conforming to this ObservationDefinition.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ObservationDefinition.quantitativeDetails.unit",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ObservationUnit"
}],
"strength" : "extensible",
"description" : "Codes identifying units of measure.",
"valueSet" : "http://hl7.org/fhir/ValueSet/ucum-units"
},
"mapping" : [{
"identity" : "v2",
"map" : "OM2-4"
}]
},
{
"id" : "ObservationDefinition.quantitativeDetails.conversionFactor",
"path" : "ObservationDefinition.quantitativeDetails.conversionFactor",
"short" : "SI to Customary unit conversion factor",
"definition" : "Factor for converting value expressed with SI unit to value expressed with customary unit.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ObservationDefinition.quantitativeDetails.conversionFactor",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "decimal"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "OM2-5"
}]
},
{
"id" : "ObservationDefinition.quantitativeDetails.decimalPrecision",
"path" : "ObservationDefinition.quantitativeDetails.decimalPrecision",
"short" : "Decimal precision of observation quantitative results",
"definition" : "Number of digits after decimal separator when the results of such observations are of type Quantity.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ObservationDefinition.quantitativeDetails.decimalPrecision",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "integer"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "OM2-3"
}]
},
{
"id" : "ObservationDefinition.qualifiedInterval",
"path" : "ObservationDefinition.qualifiedInterval",
"short" : "Qualified range for continuous and ordinal observation results",
"definition" : "Multiple ranges of results qualified by different contexts for ordinal or continuous observations conforming to this ObservationDefinition.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ObservationDefinition.qualifiedInterval",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "OM2-6"
}]
},
{
"id" : "ObservationDefinition.qualifiedInterval.id",
"path" : "ObservationDefinition.qualifiedInterval.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "ObservationDefinition.qualifiedInterval.extension",
"path" : "ObservationDefinition.qualifiedInterval.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "ObservationDefinition.qualifiedInterval.modifierExtension",
"path" : "ObservationDefinition.qualifiedInterval.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ObservationDefinition.qualifiedInterval.category",
"path" : "ObservationDefinition.qualifiedInterval.category",
"short" : "reference | critical | absolute",
"definition" : "The category of interval of values for continuous or ordinal observations conforming to this ObservationDefinition.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ObservationDefinition.qualifiedInterval.category",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"example" : [{
"label" : "General",
"valueCode" : "critical"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ObservationRangeCategory"
}],
"strength" : "required",
"description" : "Codes identifying the category of observation range.",
"valueSet" : "http://hl7.org/fhir/ValueSet/observation-range-category|4.0.1"
},
"mapping" : [{
"identity" : "v2",
"map" : "OM-2"
}]
},
{
"id" : "ObservationDefinition.qualifiedInterval.range",
"path" : "ObservationDefinition.qualifiedInterval.range",
"short" : "The interval itself, for continuous or ordinal observations",
"definition" : "The low and high values determining the interval. There may be only one of the two.",
"requirements" : "The unit may be not relevant for ordinal values. In case it is there, it is the same as quantitativeDetails.unit.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ObservationDefinition.qualifiedInterval.range",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Range"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "OM-2"
}]
},
{
"id" : "ObservationDefinition.qualifiedInterval.context",
"path" : "ObservationDefinition.qualifiedInterval.context",
"short" : "Range context qualifier",
"definition" : "Codes to indicate the health context the range applies to. For example, the normal or therapeutic range.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ObservationDefinition.qualifiedInterval.context",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ObservationRangeMeaning"
}],
"strength" : "extensible",
"description" : "Code identifying the health context of a range.",
"valueSet" : "http://hl7.org/fhir/ValueSet/referencerange-meaning"
},
"mapping" : [{
"identity" : "v2",
"map" : "n.a."
}]
},
{
"id" : "ObservationDefinition.qualifiedInterval.appliesTo",
"path" : "ObservationDefinition.qualifiedInterval.appliesTo",
"short" : "Targetted population of the range",
"definition" : "Codes to indicate the target population this reference range applies to.",
"comment" : "If this element is not present then the global population is assumed.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ObservationDefinition.qualifiedInterval.appliesTo",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ObservationRangeAppliesTo"
}],
"strength" : "example",
"description" : "Codes identifying the population the reference range applies to.",
"valueSet" : "http://hl7.org/fhir/ValueSet/referencerange-appliesto"
},
"mapping" : [{
"identity" : "v2",
"map" : "RFR.6"
}]
},
{
"id" : "ObservationDefinition.qualifiedInterval.gender",
"path" : "ObservationDefinition.qualifiedInterval.gender",
"short" : "male | female | other | unknown",
"definition" : "Sex of the population the range applies to.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ObservationDefinition.qualifiedInterval.gender",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"example" : [{
"label" : "General",
"valueCode" : "female"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AdministrativeGender"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "The gender of a person used for administrative purposes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1"
},
"mapping" : [{
"identity" : "v2",
"map" : "RFR.2"
}]
},
{
"id" : "ObservationDefinition.qualifiedInterval.age",
"path" : "ObservationDefinition.qualifiedInterval.age",
"short" : "Applicable age range, if relevant",
"definition" : "The age at which this reference range is applicable. This is a neonatal age (e.g. number of weeks at term) if the meaning says so.",
"comment" : "Some analytes vary greatly over age.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ObservationDefinition.qualifiedInterval.age",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Range"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "RFR.3"
}]
},
{
"id" : "ObservationDefinition.qualifiedInterval.gestationalAge",
"path" : "ObservationDefinition.qualifiedInterval.gestationalAge",
"short" : "Applicable gestational age range, if relevant",
"definition" : "The gestational age to which this reference range is applicable, in the context of pregnancy.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ObservationDefinition.qualifiedInterval.gestationalAge",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Range"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "RFR.4"
}]
},
{
"id" : "ObservationDefinition.qualifiedInterval.condition",
"path" : "ObservationDefinition.qualifiedInterval.condition",
"short" : "Condition associated with the reference range",
"definition" : "Text based condition for which the reference range is valid.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ObservationDefinition.qualifiedInterval.condition",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "RFR.7"
}]
},
{
"id" : "ObservationDefinition.validCodedValueSet",
"path" : "ObservationDefinition.validCodedValueSet",
"short" : "Value set of valid coded values for the observations conforming to this ObservationDefinition",
"definition" : "The set of valid coded results for the observations conforming to this ObservationDefinition.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ObservationDefinition.validCodedValueSet",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ValueSet"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "OM3-3"
}]
},
{
"id" : "ObservationDefinition.normalCodedValueSet",
"path" : "ObservationDefinition.normalCodedValueSet",
"short" : "Value set of normal coded values for the observations conforming to this ObservationDefinition",
"definition" : "The set of normal coded results for the observations conforming to this ObservationDefinition.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ObservationDefinition.normalCodedValueSet",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ValueSet"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "OM3-4"
}]
},
{
"id" : "ObservationDefinition.abnormalCodedValueSet",
"path" : "ObservationDefinition.abnormalCodedValueSet",
"short" : "Value set of abnormal coded values for the observations conforming to this ObservationDefinition",
"definition" : "The set of abnormal coded results for the observation conforming to this ObservationDefinition.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ObservationDefinition.abnormalCodedValueSet",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ValueSet"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "OM3-5"
}]
},
{
"id" : "ObservationDefinition.criticalCodedValueSet",
"path" : "ObservationDefinition.criticalCodedValueSet",
"short" : "Value set of critical coded values for the observations conforming to this ObservationDefinition",
"definition" : "The set of critical coded results for the observation conforming to this ObservationDefinition.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ObservationDefinition.criticalCodedValueSet",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ValueSet"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "OM3-6"
}]
}]
},
"differential" : {
"element" : [{
"id" : "ObservationDefinition",
"path" : "ObservationDefinition",
"short" : "Definition of an observation",
"definition" : "Set of definitional characteristics for a kind of observation or measurement produced or consumed by an orderable health care service.",
"comment" : "An instance of this resource informs the consumer of a health-related service (such as a lab diagnostic test or panel) about how the observations used or produced by this service will look like.",
"min" : 0,
"max" : "*",
"mapping" : [{
"identity" : "v2",
"map" : "OM2\nOM3\nOMC"
},
{
"identity" : "rim",
"map" : "Observation[classCode=OBS, moodCode=DEF]"
}]
},
{
"id" : "ObservationDefinition.category",
"path" : "ObservationDefinition.category",
"short" : "Category of observation",
"definition" : "A code that classifies the general type of observation.",
"comment" : "This element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used for one instance of ObservationDefinition. The level of granularity is defined by the category concepts in the value set.",
"requirements" : "Used for filtering what kinds of observations are retrieved and displayed.",
"alias" : ["Class of observation"],
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ObservationCategory"
}],
"strength" : "example",
"description" : "Codes for high level observation categories.",
"valueSet" : "http://hl7.org/fhir/ValueSet/observation-category"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.class"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=\"COMP].target[classCode=\"LIST\", moodCode=\"DEF\"].code"
}]
},
{
"id" : "ObservationDefinition.code",
"path" : "ObservationDefinition.code",
"short" : "Type of observation (code / type)",
"definition" : "Describes what will be observed. Sometimes this is called the observation \"name\".",
"requirements" : "Knowing what kind of observation is being made is essential to understanding the observation.",
"alias" : ["Name"],
"min" : 1,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ObservationCode"
}],
"strength" : "example",
"description" : "Codes identifying names of simple observations.",
"valueSet" : "http://hl7.org/fhir/ValueSet/observation-codes"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.what[x]"
},
{
"identity" : "v2",
"map" : "OM1-2\nOMC-4"
},
{
"identity" : "rim",
"map" : "code"
}]
},
{
"id" : "ObservationDefinition.identifier",
"path" : "ObservationDefinition.identifier",
"short" : "Business identifier for this ObservationDefinition instance",
"definition" : "A unique identifier assigned to this ObservationDefinition artifact.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Identifier"
}],
"isSummary" : true
},
{
"id" : "ObservationDefinition.permittedDataType",
"path" : "ObservationDefinition.permittedDataType",
"short" : "Quantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period",
"definition" : "The data types allowed for the value element of the instance observations conforming to this ObservationDefinition.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "code"
}],
"example" : [{
"label" : "General",
"valueCode" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ObservationDataType"
}],
"strength" : "required",
"description" : "Permitted data type for observation value.",
"valueSet" : "http://hl7.org/fhir/ValueSet/permitted-data-type|4.0.1"
},
"mapping" : [{
"identity" : "v2",
"map" : "OM1-3"
}]
},
{
"id" : "ObservationDefinition.multipleResultsAllowed",
"path" : "ObservationDefinition.multipleResultsAllowed",
"short" : "Multiple results allowed",
"definition" : "Multiple results allowed for observations conforming to this ObservationDefinition.",
"comment" : "An example of observation allowing multiple results is \"bacteria identified by culture\". Conversely, the measurement of a potassium level allows a single result.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "boolean"
}],
"example" : [{
"label" : "General",
"valueBoolean" : true
}]
},
{
"id" : "ObservationDefinition.method",
"path" : "ObservationDefinition.method",
"short" : "Method used to produce the observation",
"definition" : "The method or technique used to perform the observation.",
"comment" : "Only used if not implicit in observation code.",
"requirements" : "In some cases, method can impact results.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ObservationMethod"
}],
"strength" : "example",
"description" : "Methods for simple observations.",
"valueSet" : "http://hl7.org/fhir/ValueSet/observation-methods"
},
"mapping" : [{
"identity" : "v2",
"map" : "OM1-14"
},
{
"identity" : "rim",
"map" : "methodCode"
}]
},
{
"id" : "ObservationDefinition.preferredReportName",
"path" : "ObservationDefinition.preferredReportName",
"short" : "Preferred report name",
"definition" : "The preferred name to be used when reporting the results of observations conforming to this ObservationDefinition.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"mapping" : [{
"identity" : "v2",
"map" : "OM1-9"
}]
},
{
"id" : "ObservationDefinition.quantitativeDetails",
"path" : "ObservationDefinition.quantitativeDetails",
"short" : "Characteristics of quantitative results",
"definition" : "Characteristics for quantitative results of this observation.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "BackboneElement"
}],
"mapping" : [{
"identity" : "v2",
"map" : "OM2"
}]
},
{
"id" : "ObservationDefinition.quantitativeDetails.customaryUnit",
"path" : "ObservationDefinition.quantitativeDetails.customaryUnit",
"short" : "Customary unit for quantitative results",
"definition" : "Customary unit used to report quantitative results of observations conforming to this ObservationDefinition.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ObservationUnit"
}],
"strength" : "extensible",
"description" : "Codes identifying units of measure.",
"valueSet" : "http://hl7.org/fhir/ValueSet/ucum-units"
},
"mapping" : [{
"identity" : "v2",
"map" : "OM2-2"
}]
},
{
"id" : "ObservationDefinition.quantitativeDetails.unit",
"path" : "ObservationDefinition.quantitativeDetails.unit",
"short" : "SI unit for quantitative results",
"definition" : "SI unit used to report quantitative results of observations conforming to this ObservationDefinition.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ObservationUnit"
}],
"strength" : "extensible",
"description" : "Codes identifying units of measure.",
"valueSet" : "http://hl7.org/fhir/ValueSet/ucum-units"
},
"mapping" : [{
"identity" : "v2",
"map" : "OM2-4"
}]
},
{
"id" : "ObservationDefinition.quantitativeDetails.conversionFactor",
"path" : "ObservationDefinition.quantitativeDetails.conversionFactor",
"short" : "SI to Customary unit conversion factor",
"definition" : "Factor for converting value expressed with SI unit to value expressed with customary unit.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "decimal"
}],
"mapping" : [{
"identity" : "v2",
"map" : "OM2-5"
}]
},
{
"id" : "ObservationDefinition.quantitativeDetails.decimalPrecision",
"path" : "ObservationDefinition.quantitativeDetails.decimalPrecision",
"short" : "Decimal precision of observation quantitative results",
"definition" : "Number of digits after decimal separator when the results of such observations are of type Quantity.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "integer"
}],
"mapping" : [{
"identity" : "v2",
"map" : "OM2-3"
}]
},
{
"id" : "ObservationDefinition.qualifiedInterval",
"path" : "ObservationDefinition.qualifiedInterval",
"short" : "Qualified range for continuous and ordinal observation results",
"definition" : "Multiple ranges of results qualified by different contexts for ordinal or continuous observations conforming to this ObservationDefinition.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"mapping" : [{
"identity" : "v2",
"map" : "OM2-6"
}]
},
{
"id" : "ObservationDefinition.qualifiedInterval.category",
"path" : "ObservationDefinition.qualifiedInterval.category",
"short" : "reference | critical | absolute",
"definition" : "The category of interval of values for continuous or ordinal observations conforming to this ObservationDefinition.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "code"
}],
"example" : [{
"label" : "General",
"valueCode" : "critical"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ObservationRangeCategory"
}],
"strength" : "required",
"description" : "Codes identifying the category of observation range.",
"valueSet" : "http://hl7.org/fhir/ValueSet/observation-range-category|4.0.1"
},
"mapping" : [{
"identity" : "v2",
"map" : "OM-2"
}]
},
{
"id" : "ObservationDefinition.qualifiedInterval.range",
"path" : "ObservationDefinition.qualifiedInterval.range",
"short" : "The interval itself, for continuous or ordinal observations",
"definition" : "The low and high values determining the interval. There may be only one of the two.",
"requirements" : "The unit may be not relevant for ordinal values. In case it is there, it is the same as quantitativeDetails.unit.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Range"
}],
"mapping" : [{
"identity" : "v2",
"map" : "OM-2"
}]
},
{
"id" : "ObservationDefinition.qualifiedInterval.context",
"path" : "ObservationDefinition.qualifiedInterval.context",
"short" : "Range context qualifier",
"definition" : "Codes to indicate the health context the range applies to. For example, the normal or therapeutic range.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ObservationRangeMeaning"
}],
"strength" : "extensible",
"description" : "Code identifying the health context of a range.",
"valueSet" : "http://hl7.org/fhir/ValueSet/referencerange-meaning"
},
"mapping" : [{
"identity" : "v2",
"map" : "n.a."
}]
},
{
"id" : "ObservationDefinition.qualifiedInterval.appliesTo",
"path" : "ObservationDefinition.qualifiedInterval.appliesTo",
"short" : "Targetted population of the range",
"definition" : "Codes to indicate the target population this reference range applies to.",
"comment" : "If this element is not present then the global population is assumed.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ObservationRangeAppliesTo"
}],
"strength" : "example",
"description" : "Codes identifying the population the reference range applies to.",
"valueSet" : "http://hl7.org/fhir/ValueSet/referencerange-appliesto"
},
"mapping" : [{
"identity" : "v2",
"map" : "RFR.6"
}]
},
{
"id" : "ObservationDefinition.qualifiedInterval.gender",
"path" : "ObservationDefinition.qualifiedInterval.gender",
"short" : "male | female | other | unknown",
"definition" : "Sex of the population the range applies to.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "code"
}],
"example" : [{
"label" : "General",
"valueCode" : "female"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AdministrativeGender"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "The gender of a person used for administrative purposes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1"
},
"mapping" : [{
"identity" : "v2",
"map" : "RFR.2"
}]
},
{
"id" : "ObservationDefinition.qualifiedInterval.age",
"path" : "ObservationDefinition.qualifiedInterval.age",
"short" : "Applicable age range, if relevant",
"definition" : "The age at which this reference range is applicable. This is a neonatal age (e.g. number of weeks at term) if the meaning says so.",
"comment" : "Some analytes vary greatly over age.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Range"
}],
"mapping" : [{
"identity" : "v2",
"map" : "RFR.3"
}]
},
{
"id" : "ObservationDefinition.qualifiedInterval.gestationalAge",
"path" : "ObservationDefinition.qualifiedInterval.gestationalAge",
"short" : "Applicable gestational age range, if relevant",
"definition" : "The gestational age to which this reference range is applicable, in the context of pregnancy.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Range"
}],
"mapping" : [{
"identity" : "v2",
"map" : "RFR.4"
}]
},
{
"id" : "ObservationDefinition.qualifiedInterval.condition",
"path" : "ObservationDefinition.qualifiedInterval.condition",
"short" : "Condition associated with the reference range",
"definition" : "Text based condition for which the reference range is valid.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"mapping" : [{
"identity" : "v2",
"map" : "RFR.7"
}]
},
{
"id" : "ObservationDefinition.validCodedValueSet",
"path" : "ObservationDefinition.validCodedValueSet",
"short" : "Value set of valid coded values for the observations conforming to this ObservationDefinition",
"definition" : "The set of valid coded results for the observations conforming to this ObservationDefinition.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ValueSet"]
}],
"mapping" : [{
"identity" : "v2",
"map" : "OM3-3"
}]
},
{
"id" : "ObservationDefinition.normalCodedValueSet",
"path" : "ObservationDefinition.normalCodedValueSet",
"short" : "Value set of normal coded values for the observations conforming to this ObservationDefinition",
"definition" : "The set of normal coded results for the observations conforming to this ObservationDefinition.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ValueSet"]
}],
"mapping" : [{
"identity" : "v2",
"map" : "OM3-4"
}]
},
{
"id" : "ObservationDefinition.abnormalCodedValueSet",
"path" : "ObservationDefinition.abnormalCodedValueSet",
"short" : "Value set of abnormal coded values for the observations conforming to this ObservationDefinition",
"definition" : "The set of abnormal coded results for the observation conforming to this ObservationDefinition.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ValueSet"]
}],
"mapping" : [{
"identity" : "v2",
"map" : "OM3-5"
}]
},
{
"id" : "ObservationDefinition.criticalCodedValueSet",
"path" : "ObservationDefinition.criticalCodedValueSet",
"short" : "Value set of critical coded values for the observations conforming to this ObservationDefinition",
"definition" : "The set of critical coded results for the observation conforming to this ObservationDefinition.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ValueSet"]
}],
"mapping" : [{
"identity" : "v2",
"map" : "OM3-6"
}]
}]
}
}
},
{
"fullUrl" : "http://hl7.org/fhir/StructureDefinition/OperationDefinition",
"resource" : {
"resourceType" : "StructureDefinition",
"id" : "OperationDefinition",
"meta" : {
"lastUpdated" : "2019-11-01T09:29:23.356+11:00"
},
"text" : {
"status" : "generated",
"div" : "Name Flags Card. Type Description & Constraints OperationDefinition IN 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
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension url Σ 0..1 uri Canonical identifier for this operation definition, represented as a URI (globally unique) version Σ 0..1 string Business version of the operation definition name ΣI 1..1 string Name for this operation definition (computer friendly) title Σ 0..1 string Name for this operation definition (human friendly) status ?!Σ 1..1 code draft | active | retired | unknown
PublicationStatus (Required) kind Σ 1..1 code operation | query
OperationKind (Required) experimental Σ 0..1 boolean For testing purposes, not real usage date Σ 0..1 dateTime Date last changed publisher Σ 0..1 string Name of the publisher (organization or individual) contact Σ 0..* ContactDetail Contact details for the publisher
description 0..1 markdown Natural language description of the operation definition useContext ΣTU 0..* UsageContext The context that the content is intended to support
jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for operation definition (if applicable)
Jurisdiction (Extensible)
purpose 0..1 markdown Why this operation definition is defined affectsState Σ 0..1 boolean Whether content is changed by the operation code Σ 1..1 code Name used to invoke the operation comment 0..1 markdown Additional information about use base Σ 0..1 canonical(OperationDefinition) Marks this as a profile of the base resource Σ 0..* code Types this operation applies to
ResourceType (Required)
system Σ 1..1 boolean Invoke at the system level? type Σ 1..1 boolean Invoke at the type level? instance Σ 1..1 boolean Invoke on an instance? inputProfile 0..1 canonical(StructureDefinition) Validation information for in parameters outputProfile 0..1 canonical(StructureDefinition) Validation information for out parameters parameter I 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 or Canonical
name 1..1 code Name in Parameters.parameter.name or in URL use 1..1 code in | out
OperationParameterUse (Required) min 1..1 integer Minimum Cardinality max 1..1 string Maximum Cardinality (a number or *) documentation 0..1 string Description of meaning/use type I 0..1 code What type this parameter has
FHIRAllTypes (Required) targetProfile 0..* canonical(StructureDefinition) If type is Reference | canonical, allowed targets
searchType I 0..1 code number | date | string | token | reference | composite | quantity | uri | special
SearchParamType (Required) binding 0..1 BackboneElement ValueSet details if this is coded strength 1..1 code required | extensible | preferred | example
BindingStrength (Required) valueSet 1..1 canonical(ValueSet) Source of value set referencedFrom TU 0..* BackboneElement References to this parameter
source 1..1 string Referencing parameter sourceId 0..1 string Element id of reference part I 0..* see parameter Parts of a nested Parameter
overload 0..* BackboneElement Define overloaded variants for when generating code
parameterName 0..* string Name of parameter to include in overload
comment 0..1 string Comments to go on overload
Documentation for this format
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Foundation.Conformance"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "normative"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode" : "4.0.0"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 5
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "anonymous"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "fhir"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/OperationDefinition",
"version" : "4.0.1",
"name" : "OperationDefinition",
"status" : "active",
"date" : "2019-11-01T09:29:23+11:00",
"publisher" : "Health Level Seven International (FHIR Infrastructure)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/fiwg/index.cfm"
}]
}],
"description" : "A formal computable definition of an operation (on the RESTful interface) or a named query (using the search interaction).",
"fhirVersion" : "4.0.1",
"mapping" : [{
"identity" : "workflow",
"uri" : "http://hl7.org/fhir/workflow",
"name" : "Workflow Pattern"
},
{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/fivews",
"name" : "FiveWs Pattern Mapping"
},
{
"identity" : "objimpl",
"uri" : "http://hl7.org/fhir/object-implementation",
"name" : "Object Implementation Information"
}],
"kind" : "resource",
"abstract" : false,
"type" : "OperationDefinition",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"_baseDefinition" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-codegen-super",
"valueString" : "MetadataResource"
}]
},
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "OperationDefinition",
"path" : "OperationDefinition",
"short" : "Definition of an operation or a named query",
"definition" : "A formal computable definition of an operation (on the RESTful interface) or a named query (using the search interaction).",
"min" : 0,
"max" : "*",
"base" : {
"path" : "OperationDefinition",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "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",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.`div`.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "opd-0",
"severity" : "warning",
"human" : "Name should be usable as an identifier for the module by machine processing applications such as code generation",
"expression" : "name.matches('[A-Z]([A-Za-z0-9_]){0,254}')",
"xpath" : "not(exists(f:name/@value)) or matches(f:name/@value, '[A-Z]([A-Za-z0-9_]){0,254}')"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "workflow",
"map" : "Definition"
},
{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "OperationDefinition.id",
"path" : "OperationDefinition.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "OperationDefinition.meta",
"path" : "OperationDefinition.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "OperationDefinition.implicitRules",
"path" : "OperationDefinition.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "OperationDefinition.language",
"path" : "OperationDefinition.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "OperationDefinition.text",
"path" : "OperationDefinition.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "OperationDefinition.contained",
"path" : "OperationDefinition.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "OperationDefinition.extension",
"path" : "OperationDefinition.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "OperationDefinition.modifierExtension",
"path" : "OperationDefinition.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "OperationDefinition.url",
"path" : "OperationDefinition.url",
"short" : "Canonical identifier for this operation definition, represented as a URI (globally unique)",
"definition" : "An absolute URI that is used to identify this operation definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this operation definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the operation definition is stored on different servers.",
"comment" : "Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.\n\nThe determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions). \n\nIn some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.",
"requirements" : "Allows the operation definition to be referenced by a single globally unique identifier.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "OperationDefinition.url",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.url"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
}]
},
{
"id" : "OperationDefinition.version",
"path" : "OperationDefinition.version",
"short" : "Business version of the operation definition",
"definition" : "The identifier that is used to identify this version of the operation definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the operation definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.",
"comment" : "There may be different operation definition instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the operation definition with the format [url]|[version].",
"min" : 0,
"max" : "1",
"base" : {
"path" : "OperationDefinition.version",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.version"
},
{
"identity" : "w5",
"map" : "FiveWs.version"
}]
},
{
"id" : "OperationDefinition.name",
"path" : "OperationDefinition.name",
"short" : "Name for this operation definition (computer friendly)",
"definition" : "A natural language name identifying the operation definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.",
"comment" : "The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.",
"requirements" : "Support human navigation and code generation.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "OperationDefinition.name",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"condition" : ["inv-0"],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.title"
}]
},
{
"id" : "OperationDefinition.title",
"path" : "OperationDefinition.title",
"short" : "Name for this operation definition (human friendly)",
"definition" : "A short, descriptive, user-friendly title for the operation definition.",
"comment" : "This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "OperationDefinition.title",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.title"
}]
},
{
"id" : "OperationDefinition.status",
"path" : "OperationDefinition.status",
"short" : "draft | active | retired | unknown",
"definition" : "The status of this operation definition. Enables tracking the life-cycle of the content.",
"comment" : "Allows filtering of operation definitions that are appropriate for use versus not.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "OperationDefinition.status",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This is labeled as \"Is Modifier\" because applications should not use a retired {{title}} without due consideration",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "PublicationStatus"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "The lifecycle status of an artifact.",
"valueSet" : "http://hl7.org/fhir/ValueSet/publication-status|4.0.1"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.status {different ValueSet}"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
}]
},
{
"id" : "OperationDefinition.kind",
"path" : "OperationDefinition.kind",
"short" : "operation | query",
"definition" : "Whether this is an operation or a named query.",
"comment" : "Named queries are invoked differently, and have different capabilities.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "OperationDefinition.kind",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "OperationKind"
}],
"strength" : "required",
"description" : "Whether an operation is a normal operation or a query.",
"valueSet" : "http://hl7.org/fhir/ValueSet/operation-kind|4.0.1"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.class"
}]
},
{
"id" : "OperationDefinition.experimental",
"path" : "OperationDefinition.experimental",
"short" : "For testing purposes, not real usage",
"definition" : "A Boolean value to indicate that this operation definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.",
"comment" : "Allows filtering of operation definitions that are appropriate for use versus not.",
"requirements" : "Enables experimental content to be developed following the same lifecycle that would be used for a production-level operation definition.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "OperationDefinition.experimental",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.experimental"
},
{
"identity" : "w5",
"map" : "FiveWs.class"
}]
},
{
"id" : "OperationDefinition.date",
"path" : "OperationDefinition.date",
"short" : "Date last changed",
"definition" : "The date (and optionally time) when the operation definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the operation definition changes.",
"comment" : "Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the operation definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.",
"alias" : ["Revision Date"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "OperationDefinition.date",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.date"
},
{
"identity" : "w5",
"map" : "FiveWs.recorded"
}]
},
{
"id" : "OperationDefinition.publisher",
"path" : "OperationDefinition.publisher",
"short" : "Name of the publisher (organization or individual)",
"definition" : "The name of the organization or individual that published the operation definition.",
"comment" : "Usually an organization but may be an individual. The publisher (or steward) of the operation definition is the organization or individual primarily responsible for the maintenance and upkeep of the operation definition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the operation definition. This item SHOULD be populated unless the information is available from context.",
"requirements" : "Helps establish the \"authority/credibility\" of the operation definition. May also allow for contact.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "OperationDefinition.publisher",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.publisher"
},
{
"identity" : "w5",
"map" : "FiveWs.witness"
}]
},
{
"id" : "OperationDefinition.contact",
"path" : "OperationDefinition.contact",
"short" : "Contact details for the publisher",
"definition" : "Contact details to assist a user in finding and communicating with the publisher.",
"comment" : "May be a web site, an email address, a telephone number, etc.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "OperationDefinition.contact",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "ContactDetail"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.contact"
}]
},
{
"id" : "OperationDefinition.description",
"path" : "OperationDefinition.description",
"short" : "Natural language description of the operation definition",
"definition" : "A free text natural language description of the operation definition from a consumer's perspective.",
"comment" : "This description can be used to capture details such as why the operation definition was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the operation definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the operation definition is presumed to be the predominant language in the place the operation definition was created).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "OperationDefinition.description",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "markdown"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.description"
}]
},
{
"id" : "OperationDefinition.useContext",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"path" : "OperationDefinition.useContext",
"short" : "The context that the content is intended to support",
"definition" : "The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate operation definition instances.",
"comment" : "When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.",
"requirements" : "Assist in searching for appropriate content.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "OperationDefinition.useContext",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "UsageContext"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.useContext"
}]
},
{
"id" : "OperationDefinition.jurisdiction",
"path" : "OperationDefinition.jurisdiction",
"short" : "Intended jurisdiction for operation definition (if applicable)",
"definition" : "A legal or geographic region in which the operation definition is intended to be used.",
"comment" : "It may be possible for the operation definition to be used in jurisdictions other than those for which it was originally designed or intended.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "OperationDefinition.jurisdiction",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Jurisdiction"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "extensible",
"description" : "Countries and regions within which this artifact is targeted for use.",
"valueSet" : "http://hl7.org/fhir/ValueSet/jurisdiction"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.jurisdiction"
}]
},
{
"id" : "OperationDefinition.purpose",
"path" : "OperationDefinition.purpose",
"short" : "Why this operation definition is defined",
"definition" : "Explanation of why this operation definition is needed and why it has been designed as it has.",
"comment" : "This element does not describe the usage of the operation definition. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this operation definition.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "OperationDefinition.purpose",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "markdown"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.purpose"
},
{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "OperationDefinition.affectsState",
"path" : "OperationDefinition.affectsState",
"short" : "Whether content is changed by the operation",
"definition" : "Whether the operation affects state. Side effects such as producing audit trail entries do not count as 'affecting state'.",
"comment" : "What http methods can be used for the operation depends on the .affectsState value and whether the input parameters are primitive or complex:\n\n1. Servers SHALL support POST method for all operations.\n\n2. Servers SHALL support GET method if all the parameters for the operation are primitive or there are no parameters and the operation has affectsState = false.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "OperationDefinition.affectsState",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "OperationDefinition.code",
"path" : "OperationDefinition.code",
"short" : "Name used to invoke the operation",
"definition" : "The name used to invoke the operation.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "OperationDefinition.code",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "OperationDefinition.comment",
"path" : "OperationDefinition.comment",
"short" : "Additional information about use",
"definition" : "Additional information about how to use this operation or named query.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "OperationDefinition.comment",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "markdown"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "OperationDefinition.base",
"path" : "OperationDefinition.base",
"short" : "Marks this as a profile of the base",
"definition" : "Indicates that this operation definition is a constraining profile on the base.",
"comment" : "A constrained profile can make optional parameters required or not used and clarify documentation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "OperationDefinition.base",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/OperationDefinition"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.derivedFrom"
}]
},
{
"id" : "OperationDefinition.resource",
"path" : "OperationDefinition.resource",
"short" : "Types this operation applies to",
"definition" : "The types on which this operation can be executed.",
"comment" : "If the type is an abstract resource (\"Resource\" or \"DomainResource\") then the operation can be invoked on any concrete specialization.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "OperationDefinition.resource",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ResourceType"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "One of the resource types defined as part of this version of FHIR.",
"valueSet" : "http://hl7.org/fhir/ValueSet/resource-types|4.0.1"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.subject[x]"
}]
},
{
"id" : "OperationDefinition.system",
"path" : "OperationDefinition.system",
"short" : "Invoke at the system level?",
"definition" : "Indicates whether this operation or named query can be invoked at the system level (e.g. without needing to choose a resource type for the context).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "OperationDefinition.system",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "OperationDefinition.type",
"path" : "OperationDefinition.type",
"short" : "Invoke at the type level?",
"definition" : "Indicates whether this operation or named query can be invoked at the resource type level for any given resource type level (e.g. without needing to choose a specific resource id for the context).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "OperationDefinition.type",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "OperationDefinition.instance",
"path" : "OperationDefinition.instance",
"short" : "Invoke on an instance?",
"definition" : "Indicates whether this operation can be invoked on a particular instance of one of the given types.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "OperationDefinition.instance",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "OperationDefinition.inputProfile",
"path" : "OperationDefinition.inputProfile",
"short" : "Validation information for in parameters",
"definition" : "Additional validation information for the in parameters - a single profile that covers all the parameters. The profile is a constraint on the parameters resource as a whole.",
"comment" : "If present the profile shall not conflict with what is specified in the parameters in the operation definition (max/min etc.), though it may provide additional constraints. The constraints expressed in the profile apply whether the operation is invoked by a POST wih parameters or not.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "OperationDefinition.inputProfile",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/StructureDefinition"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "OperationDefinition.outputProfile",
"path" : "OperationDefinition.outputProfile",
"short" : "Validation information for out parameters",
"definition" : "Additional validation information for the out parameters - a single profile that covers all the parameters. The profile is a constraint on the parameters resource.",
"comment" : "If present the profile shall not conflict with what is specified in the parameters in the operation definition (max/min etc.), though it may provide additional constraints. The constraints expressed in the profile apply whether the operation is invoked by a POST wih parameters or not.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "OperationDefinition.outputProfile",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/StructureDefinition"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "OperationDefinition.parameter",
"path" : "OperationDefinition.parameter",
"short" : "Parameters for the operation/query",
"definition" : "The parameters for the operation/query.",
"comment" : "Query Definitions only have one output parameter, named \"result\". This might not be described, but can be to allow a profile to be defined.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "OperationDefinition.parameter",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "opd-1",
"severity" : "error",
"human" : "Either a type must be provided, or parts",
"expression" : "type.exists() or part.exists()",
"xpath" : "exists(f:type) or exists(f:part)"
},
{
"key" : "opd-2",
"severity" : "error",
"human" : "A search type can only be specified for parameters of type string",
"expression" : "searchType.exists() implies type = 'string'",
"xpath" : "not(exists(f:searchType)) or (f:type/@value = 'string')"
},
{
"key" : "opd-3",
"severity" : "error",
"human" : "A targetProfile can only be specified for parameters of type Reference or Canonical",
"expression" : "targetProfile.exists() implies (type = 'Reference' or type = 'canonical')",
"xpath" : "not(exists(f:targetProfile)) or ((f:type/@value = 'Reference') or (f:type/@value = 'canonical'))"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "OperationDefinition.parameter.id",
"path" : "OperationDefinition.parameter.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "OperationDefinition.parameter.extension",
"path" : "OperationDefinition.parameter.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "OperationDefinition.parameter.modifierExtension",
"path" : "OperationDefinition.parameter.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "OperationDefinition.parameter.name",
"path" : "OperationDefinition.parameter.name",
"short" : "Name in Parameters.parameter.name or in URL",
"definition" : "The name of used to identify the parameter.",
"comment" : "This name must be a token (start with a letter in a..z, and only contain letters, numerals, and underscore. Note that for search parameters (type = string, with a search type), the name may be altered by the search modifiers.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "OperationDefinition.parameter.name",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "OperationDefinition.parameter.use",
"path" : "OperationDefinition.parameter.use",
"short" : "in | out",
"definition" : "Whether this is an input or an output parameter.",
"comment" : "If a parameter name is used for both an input and an output parameter, the parameter should be defined twice.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "OperationDefinition.parameter.use",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "OperationParameterUse"
}],
"strength" : "required",
"description" : "Whether an operation parameter is an input or an output parameter.",
"valueSet" : "http://hl7.org/fhir/ValueSet/operation-parameter-use|4.0.1"
}
},
{
"id" : "OperationDefinition.parameter.min",
"path" : "OperationDefinition.parameter.min",
"short" : "Minimum Cardinality",
"definition" : "The minimum number of times this parameter SHALL appear in the request or response.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "OperationDefinition.parameter.min",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "integer"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "OperationDefinition.parameter.max",
"path" : "OperationDefinition.parameter.max",
"short" : "Maximum Cardinality (a number or *)",
"definition" : "The maximum number of times this element is permitted to appear in the request or response.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "OperationDefinition.parameter.max",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "OperationDefinition.parameter.documentation",
"path" : "OperationDefinition.parameter.documentation",
"short" : "Description of meaning/use",
"definition" : "Describes the meaning or use of this parameter.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "OperationDefinition.parameter.documentation",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "OperationDefinition.parameter.type",
"path" : "OperationDefinition.parameter.type",
"short" : "What type this parameter has",
"definition" : "The type for this parameter.",
"comment" : "if there is no stated parameter, then the parameter is a multi-part parameter; type and must have at least one part defined.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "OperationDefinition.parameter.type",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"condition" : ["opd-1"],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "FHIRAllTypes"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.",
"valueSet" : "http://hl7.org/fhir/ValueSet/all-types|4.0.1"
}
},
{
"id" : "OperationDefinition.parameter.targetProfile",
"path" : "OperationDefinition.parameter.targetProfile",
"short" : "If type is Reference | canonical, allowed targets",
"definition" : "Used when the type is \"Reference\" or \"canonical\", and identifies a profile structure or implementation Guide that applies to the target of the reference this parameter refers to. If any profiles are specified, then the content must conform to at least one of them. The URL can be a local reference - to a contained StructureDefinition, or a reference to another StructureDefinition or Implementation Guide by a canonical URL. When an implementation guide is specified, the target resource SHALL conform to at least one profile defined in the implementation guide.",
"comment" : "Often, these profiles are the base definitions from the spec (e.g. http://hl7.org/fhir/StructureDefinition/Patient).",
"min" : 0,
"max" : "*",
"base" : {
"path" : "OperationDefinition.parameter.targetProfile",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/StructureDefinition"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "OperationDefinition.parameter.searchType",
"path" : "OperationDefinition.parameter.searchType",
"short" : "number | date | string | token | reference | composite | quantity | uri | special",
"definition" : "How the parameter is understood as a search parameter. This is only used if the parameter type is 'string'.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "OperationDefinition.parameter.searchType",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"condition" : ["opd-2"],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SearchParamType"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "Data types allowed to be used for search parameters.",
"valueSet" : "http://hl7.org/fhir/ValueSet/search-param-type|4.0.1"
}
},
{
"id" : "OperationDefinition.parameter.binding",
"path" : "OperationDefinition.parameter.binding",
"short" : "ValueSet details if this is coded",
"definition" : "Binds to a value set if this parameter is coded (code, Coding, CodeableConcept).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "OperationDefinition.parameter.binding",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "OperationDefinition.parameter.binding.id",
"path" : "OperationDefinition.parameter.binding.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "OperationDefinition.parameter.binding.extension",
"path" : "OperationDefinition.parameter.binding.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "OperationDefinition.parameter.binding.modifierExtension",
"path" : "OperationDefinition.parameter.binding.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "OperationDefinition.parameter.binding.strength",
"path" : "OperationDefinition.parameter.binding.strength",
"short" : "required | extensible | preferred | example",
"definition" : "Indicates the degree of conformance expectations associated with this binding - that is, the degree to which the provided value set must be adhered to in the instances.",
"comment" : "For further discussion, see [Using Terminologies](terminologies.html).",
"alias" : ["conformance",
"extensibility"],
"min" : 1,
"max" : "1",
"base" : {
"path" : "OperationDefinition.parameter.binding.strength",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "BindingStrength"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "Indication of the degree of conformance expectations associated with a binding.",
"valueSet" : "http://hl7.org/fhir/ValueSet/binding-strength|4.0.1"
}
},
{
"id" : "OperationDefinition.parameter.binding.valueSet",
"path" : "OperationDefinition.parameter.binding.valueSet",
"short" : "Source of value set",
"definition" : "Points to the value set or external definition (e.g. implicit value set) that identifies the set of codes to be used.",
"comment" : "For value sets with a referenceResource, the display can contain the value set description. The reference may be version-specific or not.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "OperationDefinition.parameter.binding.valueSet",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ValueSet"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "OperationDefinition.parameter.referencedFrom",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"path" : "OperationDefinition.parameter.referencedFrom",
"short" : "References to this parameter",
"definition" : "Identifies other resource parameters within the operation invocation that are expected to resolve to this resource.",
"comment" : "Resolution applies if the referenced parameter exists.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "OperationDefinition.parameter.referencedFrom",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "OperationDefinition.parameter.referencedFrom.id",
"path" : "OperationDefinition.parameter.referencedFrom.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "OperationDefinition.parameter.referencedFrom.extension",
"path" : "OperationDefinition.parameter.referencedFrom.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "OperationDefinition.parameter.referencedFrom.modifierExtension",
"path" : "OperationDefinition.parameter.referencedFrom.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "OperationDefinition.parameter.referencedFrom.source",
"path" : "OperationDefinition.parameter.referencedFrom.source",
"short" : "Referencing parameter",
"definition" : "The name of the parameter or dot-separated path of parameter names pointing to the resource parameter that is expected to contain a reference to this resource.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "OperationDefinition.parameter.referencedFrom.source",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "OperationDefinition.parameter.referencedFrom.sourceId",
"path" : "OperationDefinition.parameter.referencedFrom.sourceId",
"short" : "Element id of reference",
"definition" : "The id of the element in the referencing resource that is expected to resolve to this resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "OperationDefinition.parameter.referencedFrom.sourceId",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "OperationDefinition.parameter.part",
"path" : "OperationDefinition.parameter.part",
"short" : "Parts of a nested Parameter",
"definition" : "The parts of a nested Parameter.",
"comment" : "Query Definitions only have one output parameter, named \"result\". This might not be described, but can be to allow a profile to be defined.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "OperationDefinition.parameter.part",
"min" : 0,
"max" : "*"
},
"contentReference" : "#OperationDefinition.parameter",
"condition" : ["opd-1"],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "OperationDefinition.overload",
"path" : "OperationDefinition.overload",
"short" : "Define overloaded variants for when generating code",
"definition" : "Defines an appropriate combination of parameters to use when invoking this operation, to help code generators when generating overloaded parameter sets for this operation.",
"comment" : "The combinations are suggestions as to which sets of parameters to use together, but the combinations are not intended to be authoritative.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "OperationDefinition.overload",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "OperationDefinition.overload.id",
"path" : "OperationDefinition.overload.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "OperationDefinition.overload.extension",
"path" : "OperationDefinition.overload.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "OperationDefinition.overload.modifierExtension",
"path" : "OperationDefinition.overload.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "OperationDefinition.overload.parameterName",
"path" : "OperationDefinition.overload.parameterName",
"short" : "Name of parameter to include in overload",
"definition" : "Name of parameter to include in overload.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "OperationDefinition.overload.parameterName",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "OperationDefinition.overload.comment",
"path" : "OperationDefinition.overload.comment",
"short" : "Comments to go on overload",
"definition" : "Comments to go on overload.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "OperationDefinition.overload.comment",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
}]
},
"differential" : {
"element" : [{
"id" : "OperationDefinition",
"path" : "OperationDefinition",
"short" : "Definition of an operation or a named query",
"definition" : "A formal computable definition of an operation (on the RESTful interface) or a named query (using the search interaction).",
"min" : 0,
"max" : "*",
"constraint" : [{
"key" : "opd-0",
"severity" : "warning",
"human" : "Name should be usable as an identifier for the module by machine processing applications such as code generation",
"expression" : "name.matches('[A-Z]([A-Za-z0-9_]){0,254}')",
"xpath" : "not(exists(f:name/@value)) or matches(f:name/@value, '[A-Z]([A-Za-z0-9_]){0,254}')"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Definition"
},
{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "OperationDefinition.url",
"path" : "OperationDefinition.url",
"short" : "Canonical identifier for this operation definition, represented as a URI (globally unique)",
"definition" : "An absolute URI that is used to identify this operation definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this operation definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the operation definition is stored on different servers.",
"comment" : "Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.\n\nThe determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions). \n\nIn some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.",
"requirements" : "Allows the operation definition to be referenced by a single globally unique identifier.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "uri"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.url"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
}]
},
{
"id" : "OperationDefinition.version",
"path" : "OperationDefinition.version",
"short" : "Business version of the operation definition",
"definition" : "The identifier that is used to identify this version of the operation definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the operation definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.",
"comment" : "There may be different operation definition instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the operation definition with the format [url]|[version].",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.version"
},
{
"identity" : "w5",
"map" : "FiveWs.version"
}]
},
{
"id" : "OperationDefinition.name",
"path" : "OperationDefinition.name",
"short" : "Name for this operation definition (computer friendly)",
"definition" : "A natural language name identifying the operation definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.",
"comment" : "The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.",
"requirements" : "Support human navigation and code generation.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "string"
}],
"condition" : ["inv-0"],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.title"
}]
},
{
"id" : "OperationDefinition.title",
"path" : "OperationDefinition.title",
"short" : "Name for this operation definition (human friendly)",
"definition" : "A short, descriptive, user-friendly title for the operation definition.",
"comment" : "This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.title"
}]
},
{
"id" : "OperationDefinition.status",
"path" : "OperationDefinition.status",
"short" : "draft | active | retired | unknown",
"definition" : "The status of this operation definition. Enables tracking the life-cycle of the content.",
"comment" : "Allows filtering of operation definitions that are appropriate for use versus not.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isModifier" : true,
"isModifierReason" : "This is labeled as \"Is Modifier\" because applications should not use a retired {{title}} without due consideration",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "PublicationStatus"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "The lifecycle status of an artifact.",
"valueSet" : "http://hl7.org/fhir/ValueSet/publication-status|4.0.1"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.status {different ValueSet}"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
}]
},
{
"id" : "OperationDefinition.kind",
"path" : "OperationDefinition.kind",
"short" : "operation | query",
"definition" : "Whether this is an operation or a named query.",
"comment" : "Named queries are invoked differently, and have different capabilities.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "OperationKind"
}],
"strength" : "required",
"description" : "Whether an operation is a normal operation or a query.",
"valueSet" : "http://hl7.org/fhir/ValueSet/operation-kind|4.0.1"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.class"
}]
},
{
"id" : "OperationDefinition.experimental",
"path" : "OperationDefinition.experimental",
"short" : "For testing purposes, not real usage",
"definition" : "A Boolean value to indicate that this operation definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.",
"comment" : "Allows filtering of operation definitions that are appropriate for use versus not.",
"requirements" : "Enables experimental content to be developed following the same lifecycle that would be used for a production-level operation definition.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "boolean"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.experimental"
},
{
"identity" : "w5",
"map" : "FiveWs.class"
}]
},
{
"id" : "OperationDefinition.date",
"path" : "OperationDefinition.date",
"short" : "Date last changed",
"definition" : "The date (and optionally time) when the operation definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the operation definition changes.",
"comment" : "Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the operation definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.",
"alias" : ["Revision Date"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "dateTime"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.date"
},
{
"identity" : "w5",
"map" : "FiveWs.recorded"
}]
},
{
"id" : "OperationDefinition.publisher",
"path" : "OperationDefinition.publisher",
"short" : "Name of the publisher (organization or individual)",
"definition" : "The name of the organization or individual that published the operation definition.",
"comment" : "Usually an organization but may be an individual. The publisher (or steward) of the operation definition is the organization or individual primarily responsible for the maintenance and upkeep of the operation definition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the operation definition. This item SHOULD be populated unless the information is available from context.",
"requirements" : "Helps establish the \"authority/credibility\" of the operation definition. May also allow for contact.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.publisher"
},
{
"identity" : "w5",
"map" : "FiveWs.witness"
}]
},
{
"id" : "OperationDefinition.contact",
"path" : "OperationDefinition.contact",
"short" : "Contact details for the publisher",
"definition" : "Contact details to assist a user in finding and communicating with the publisher.",
"comment" : "May be a web site, an email address, a telephone number, etc.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "ContactDetail"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.contact"
}]
},
{
"id" : "OperationDefinition.description",
"path" : "OperationDefinition.description",
"short" : "Natural language description of the operation definition",
"definition" : "A free text natural language description of the operation definition from a consumer's perspective.",
"comment" : "This description can be used to capture details such as why the operation definition was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the operation definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the operation definition is presumed to be the predominant language in the place the operation definition was created).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "markdown"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.description"
}]
},
{
"id" : "OperationDefinition.useContext",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"path" : "OperationDefinition.useContext",
"short" : "The context that the content is intended to support",
"definition" : "The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate operation definition instances.",
"comment" : "When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.",
"requirements" : "Assist in searching for appropriate content.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "UsageContext"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.useContext"
}]
},
{
"id" : "OperationDefinition.jurisdiction",
"path" : "OperationDefinition.jurisdiction",
"short" : "Intended jurisdiction for operation definition (if applicable)",
"definition" : "A legal or geographic region in which the operation definition is intended to be used.",
"comment" : "It may be possible for the operation definition to be used in jurisdictions other than those for which it was originally designed or intended.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Jurisdiction"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "extensible",
"description" : "Countries and regions within which this artifact is targeted for use.",
"valueSet" : "http://hl7.org/fhir/ValueSet/jurisdiction"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.jurisdiction"
}]
},
{
"id" : "OperationDefinition.purpose",
"path" : "OperationDefinition.purpose",
"short" : "Why this operation definition is defined",
"definition" : "Explanation of why this operation definition is needed and why it has been designed as it has.",
"comment" : "This element does not describe the usage of the operation definition. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this operation definition.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "markdown"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.purpose"
},
{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "OperationDefinition.affectsState",
"path" : "OperationDefinition.affectsState",
"short" : "Whether content is changed by the operation",
"definition" : "Whether the operation affects state. Side effects such as producing audit trail entries do not count as 'affecting state'.",
"comment" : "What http methods can be used for the operation depends on the .affectsState value and whether the input parameters are primitive or complex:\n\n1. Servers SHALL support POST method for all operations.\n\n2. Servers SHALL support GET method if all the parameters for the operation are primitive or there are no parameters and the operation has affectsState = false.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "boolean"
}],
"isSummary" : true
},
{
"id" : "OperationDefinition.code",
"path" : "OperationDefinition.code",
"short" : "Name used to invoke the operation",
"definition" : "The name used to invoke the operation.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isSummary" : true
},
{
"id" : "OperationDefinition.comment",
"path" : "OperationDefinition.comment",
"short" : "Additional information about use",
"definition" : "Additional information about how to use this operation or named query.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "markdown"
}]
},
{
"id" : "OperationDefinition.base",
"path" : "OperationDefinition.base",
"short" : "Marks this as a profile of the base",
"definition" : "Indicates that this operation definition is a constraining profile on the base.",
"comment" : "A constrained profile can make optional parameters required or not used and clarify documentation.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/OperationDefinition"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.derivedFrom"
}]
},
{
"id" : "OperationDefinition.resource",
"path" : "OperationDefinition.resource",
"short" : "Types this operation applies to",
"definition" : "The types on which this operation can be executed.",
"comment" : "If the type is an abstract resource (\"Resource\" or \"DomainResource\") then the operation can be invoked on any concrete specialization.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "code"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ResourceType"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "One of the resource types defined as part of this version of FHIR.",
"valueSet" : "http://hl7.org/fhir/ValueSet/resource-types|4.0.1"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.subject[x]"
}]
},
{
"id" : "OperationDefinition.system",
"path" : "OperationDefinition.system",
"short" : "Invoke at the system level?",
"definition" : "Indicates whether this operation or named query can be invoked at the system level (e.g. without needing to choose a resource type for the context).",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "boolean"
}],
"isSummary" : true
},
{
"id" : "OperationDefinition.type",
"path" : "OperationDefinition.type",
"short" : "Invoke at the type level?",
"definition" : "Indicates whether this operation or named query can be invoked at the resource type level for any given resource type level (e.g. without needing to choose a specific resource id for the context).",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "boolean"
}],
"isSummary" : true
},
{
"id" : "OperationDefinition.instance",
"path" : "OperationDefinition.instance",
"short" : "Invoke on an instance?",
"definition" : "Indicates whether this operation can be invoked on a particular instance of one of the given types.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "boolean"
}],
"isSummary" : true
},
{
"id" : "OperationDefinition.inputProfile",
"path" : "OperationDefinition.inputProfile",
"short" : "Validation information for in parameters",
"definition" : "Additional validation information for the in parameters - a single profile that covers all the parameters. The profile is a constraint on the parameters resource as a whole.",
"comment" : "If present the profile shall not conflict with what is specified in the parameters in the operation definition (max/min etc.), though it may provide additional constraints. The constraints expressed in the profile apply whether the operation is invoked by a POST wih parameters or not.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/StructureDefinition"]
}]
},
{
"id" : "OperationDefinition.outputProfile",
"path" : "OperationDefinition.outputProfile",
"short" : "Validation information for out parameters",
"definition" : "Additional validation information for the out parameters - a single profile that covers all the parameters. The profile is a constraint on the parameters resource.",
"comment" : "If present the profile shall not conflict with what is specified in the parameters in the operation definition (max/min etc.), though it may provide additional constraints. The constraints expressed in the profile apply whether the operation is invoked by a POST wih parameters or not.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/StructureDefinition"]
}]
},
{
"id" : "OperationDefinition.parameter",
"path" : "OperationDefinition.parameter",
"short" : "Parameters for the operation/query",
"definition" : "The parameters for the operation/query.",
"comment" : "Query Definitions only have one output parameter, named \"result\". This might not be described, but can be to allow a profile to be defined.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "opd-1",
"severity" : "error",
"human" : "Either a type must be provided, or parts",
"expression" : "type.exists() or part.exists()",
"xpath" : "exists(f:type) or exists(f:part)"
},
{
"key" : "opd-2",
"severity" : "error",
"human" : "A search type can only be specified for parameters of type string",
"expression" : "searchType.exists() implies type = 'string'",
"xpath" : "not(exists(f:searchType)) or (f:type/@value = 'string')"
},
{
"key" : "opd-3",
"severity" : "error",
"human" : "A targetProfile can only be specified for parameters of type Reference or Canonical",
"expression" : "targetProfile.exists() implies (type = 'Reference' or type = 'canonical')",
"xpath" : "not(exists(f:targetProfile)) or ((f:type/@value = 'Reference') or (f:type/@value = 'canonical'))"
}]
},
{
"id" : "OperationDefinition.parameter.name",
"path" : "OperationDefinition.parameter.name",
"short" : "Name in Parameters.parameter.name or in URL",
"definition" : "The name of used to identify the parameter.",
"comment" : "This name must be a token (start with a letter in a..z, and only contain letters, numerals, and underscore. Note that for search parameters (type = string, with a search type), the name may be altered by the search modifiers.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}]
},
{
"id" : "OperationDefinition.parameter.use",
"path" : "OperationDefinition.parameter.use",
"short" : "in | out",
"definition" : "Whether this is an input or an output parameter.",
"comment" : "If a parameter name is used for both an input and an output parameter, the parameter should be defined twice.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "OperationParameterUse"
}],
"strength" : "required",
"description" : "Whether an operation parameter is an input or an output parameter.",
"valueSet" : "http://hl7.org/fhir/ValueSet/operation-parameter-use|4.0.1"
}
},
{
"id" : "OperationDefinition.parameter.min",
"path" : "OperationDefinition.parameter.min",
"short" : "Minimum Cardinality",
"definition" : "The minimum number of times this parameter SHALL appear in the request or response.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "integer"
}]
},
{
"id" : "OperationDefinition.parameter.max",
"path" : "OperationDefinition.parameter.max",
"short" : "Maximum Cardinality (a number or *)",
"definition" : "The maximum number of times this element is permitted to appear in the request or response.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "string"
}]
},
{
"id" : "OperationDefinition.parameter.documentation",
"path" : "OperationDefinition.parameter.documentation",
"short" : "Description of meaning/use",
"definition" : "Describes the meaning or use of this parameter.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}]
},
{
"id" : "OperationDefinition.parameter.type",
"path" : "OperationDefinition.parameter.type",
"short" : "What type this parameter has",
"definition" : "The type for this parameter.",
"comment" : "if there is no stated parameter, then the parameter is a multi-part parameter; type and must have at least one part defined.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "code"
}],
"condition" : ["opd-1"],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "FHIRAllTypes"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.",
"valueSet" : "http://hl7.org/fhir/ValueSet/all-types|4.0.1"
}
},
{
"id" : "OperationDefinition.parameter.targetProfile",
"path" : "OperationDefinition.parameter.targetProfile",
"short" : "If type is Reference | canonical, allowed targets",
"definition" : "Used when the type is \"Reference\" or \"canonical\", and identifies a profile structure or implementation Guide that applies to the target of the reference this parameter refers to. If any profiles are specified, then the content must conform to at least one of them. The URL can be a local reference - to a contained StructureDefinition, or a reference to another StructureDefinition or Implementation Guide by a canonical URL. When an implementation guide is specified, the target resource SHALL conform to at least one profile defined in the implementation guide.",
"comment" : "Often, these profiles are the base definitions from the spec (e.g. http://hl7.org/fhir/StructureDefinition/Patient).",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/StructureDefinition"]
}]
},
{
"id" : "OperationDefinition.parameter.searchType",
"path" : "OperationDefinition.parameter.searchType",
"short" : "number | date | string | token | reference | composite | quantity | uri | special",
"definition" : "How the parameter is understood as a search parameter. This is only used if the parameter type is 'string'.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "code"
}],
"condition" : ["opd-2"],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SearchParamType"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "Data types allowed to be used for search parameters.",
"valueSet" : "http://hl7.org/fhir/ValueSet/search-param-type|4.0.1"
}
},
{
"id" : "OperationDefinition.parameter.binding",
"path" : "OperationDefinition.parameter.binding",
"short" : "ValueSet details if this is coded",
"definition" : "Binds to a value set if this parameter is coded (code, Coding, CodeableConcept).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "OperationDefinition.parameter.binding.strength",
"path" : "OperationDefinition.parameter.binding.strength",
"short" : "required | extensible | preferred | example",
"definition" : "Indicates the degree of conformance expectations associated with this binding - that is, the degree to which the provided value set must be adhered to in the instances.",
"comment" : "For further discussion, see [Using Terminologies](terminologies.html).",
"alias" : ["conformance",
"extensibility"],
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "BindingStrength"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "Indication of the degree of conformance expectations associated with a binding.",
"valueSet" : "http://hl7.org/fhir/ValueSet/binding-strength|4.0.1"
}
},
{
"id" : "OperationDefinition.parameter.binding.valueSet",
"path" : "OperationDefinition.parameter.binding.valueSet",
"short" : "Source of value set",
"definition" : "Points to the value set or external definition (e.g. implicit value set) that identifies the set of codes to be used.",
"comment" : "For value sets with a referenceResource, the display can contain the value set description. The reference may be version-specific or not.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ValueSet"]
}]
},
{
"id" : "OperationDefinition.parameter.referencedFrom",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"path" : "OperationDefinition.parameter.referencedFrom",
"short" : "References to this parameter",
"definition" : "Identifies other resource parameters within the operation invocation that are expected to resolve to this resource.",
"comment" : "Resolution applies if the referenced parameter exists.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "OperationDefinition.parameter.referencedFrom.source",
"path" : "OperationDefinition.parameter.referencedFrom.source",
"short" : "Referencing parameter",
"definition" : "The name of the parameter or dot-separated path of parameter names pointing to the resource parameter that is expected to contain a reference to this resource.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "string"
}]
},
{
"id" : "OperationDefinition.parameter.referencedFrom.sourceId",
"path" : "OperationDefinition.parameter.referencedFrom.sourceId",
"short" : "Element id of reference",
"definition" : "The id of the element in the referencing resource that is expected to resolve to this resource.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}]
},
{
"id" : "OperationDefinition.parameter.part",
"path" : "OperationDefinition.parameter.part",
"short" : "Parts of a nested Parameter",
"definition" : "The parts of a nested Parameter.",
"comment" : "Query Definitions only have one output parameter, named \"result\". This might not be described, but can be to allow a profile to be defined.",
"min" : 0,
"max" : "*",
"contentReference" : "#OperationDefinition.parameter",
"condition" : ["opd-1"]
},
{
"id" : "OperationDefinition.overload",
"path" : "OperationDefinition.overload",
"short" : "Define overloaded variants for when generating code",
"definition" : "Defines an appropriate combination of parameters to use when invoking this operation, to help code generators when generating overloaded parameter sets for this operation.",
"comment" : "The combinations are suggestions as to which sets of parameters to use together, but the combinations are not intended to be authoritative.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "OperationDefinition.overload.parameterName",
"path" : "OperationDefinition.overload.parameterName",
"short" : "Name of parameter to include in overload",
"definition" : "Name of parameter to include in overload.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "string"
}]
},
{
"id" : "OperationDefinition.overload.comment",
"path" : "OperationDefinition.overload.comment",
"short" : "Comments to go on overload",
"definition" : "Comments to go on overload.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}]
}]
}
}
},
{
"fullUrl" : "http://hl7.org/fhir/StructureDefinition/OperationOutcome",
"resource" : {
"resourceType" : "StructureDefinition",
"id" : "OperationOutcome",
"meta" : {
"lastUpdated" : "2019-11-01T09:29:23.356+11:00"
},
"text" : {
"status" : "generated",
"div" : "Name Flags Card. Type Description & Constraints OperationOutcome ΣN DomainResource Information about the success/failure of an action
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension issue Σ 1..* BackboneElement A single issue associated with the action
severity Σ 1..1 code fatal | error | warning | information
IssueSeverity (Required) code Σ 1..1 code Error or warning code
IssueType (Required) details Σ 0..1 CodeableConcept Additional details about the error
Operation Outcome Codes (Example) diagnostics Σ 0..1 string Additional diagnostic information about the issue location ΣXD 0..* string Deprecated: Path of element(s) related to issue
expression Σ 0..* string FHIRPath of element(s) related to issue
Documentation for this format
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Foundation.Other"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "normative"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode" : "4.0.0"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 5
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "fhir"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/OperationOutcome",
"version" : "4.0.1",
"name" : "OperationOutcome",
"status" : "active",
"date" : "2019-11-01T09:29:23+11:00",
"publisher" : "Health Level Seven International (FHIR Infrastructure)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/fiwg/index.cfm"
}]
}],
"description" : "A collection of error, warning, or information messages that result from a system action.",
"fhirVersion" : "4.0.1",
"mapping" : [{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
},
{
"identity" : "v2",
"uri" : "http://hl7.org/v2",
"name" : "HL7 v2 Mapping"
}],
"kind" : "resource",
"abstract" : false,
"type" : "OperationOutcome",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "OperationOutcome",
"path" : "OperationOutcome",
"short" : "Information about the success/failure of an action",
"definition" : "A collection of error, warning, or information messages that result from a system action.",
"comment" : "Can result from the failure of a REST call or be part of the response message returned from a request message.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "OperationOutcome",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "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",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.`div`.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "rim",
"map" : "Grouping is handled through multiple repetitions from whatever context references the outcomes (no specific grouper required)"
}]
},
{
"id" : "OperationOutcome.id",
"path" : "OperationOutcome.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "OperationOutcome.meta",
"path" : "OperationOutcome.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "OperationOutcome.implicitRules",
"path" : "OperationOutcome.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "OperationOutcome.language",
"path" : "OperationOutcome.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "OperationOutcome.text",
"path" : "OperationOutcome.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "OperationOutcome.contained",
"path" : "OperationOutcome.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "OperationOutcome.extension",
"path" : "OperationOutcome.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "OperationOutcome.modifierExtension",
"path" : "OperationOutcome.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "OperationOutcome.issue",
"path" : "OperationOutcome.issue",
"short" : "A single issue associated with the action",
"definition" : "An error, warning, or information message that results from a system action.",
"min" : 1,
"max" : "*",
"base" : {
"path" : "OperationOutcome.issue",
"min" : 1,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "v2",
"map" : "ERR"
},
{
"identity" : "rim",
"map" : "AcknowledgementDetail or Observation[classCode=\"ALRT\" and moodCode=\"EVN\"]"
}]
},
{
"id" : "OperationOutcome.issue.id",
"path" : "OperationOutcome.issue.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "OperationOutcome.issue.extension",
"path" : "OperationOutcome.issue.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "OperationOutcome.issue.modifierExtension",
"path" : "OperationOutcome.issue.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "OperationOutcome.issue.severity",
"path" : "OperationOutcome.issue.severity",
"short" : "fatal | error | warning | information",
"definition" : "Indicates whether the issue indicates a variation from successful processing.",
"comment" : "This is labeled as \"Is Modifier\" because applications should not confuse hints and warnings with errors.",
"requirements" : "Indicates how relevant the issue is to the overall success of the action.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "OperationOutcome.issue.severity",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "IssueSeverity"
}],
"strength" : "required",
"description" : "How the issue affects the success of the action.",
"valueSet" : "http://hl7.org/fhir/ValueSet/issue-severity|4.0.1"
},
"mapping" : [{
"identity" : "v2",
"map" : "ERR-4"
},
{
"identity" : "rim",
"map" : "./typeCode[parent::AcknowledgmentDetail] or unique(./inboundRelationship[parent::Observation and typeCode='SUBJ' and isNormalActRelationship()]/source[classCode=\"OBS\" and moodCode=\"EVN\" and implies(code, ActCode#SEV and isNormalAct())/value[xsi:type=\"CD\"]"
}]
},
{
"id" : "OperationOutcome.issue.code",
"path" : "OperationOutcome.issue.code",
"short" : "Error or warning code",
"definition" : "Describes the type of the issue. The system that creates an OperationOutcome SHALL choose the most applicable code from the IssueType value set, and may additional provide its own code for the error in the details element.",
"requirements" : "Expresses the issue in a human and computer-friendly way, allowing the requesting system to behave differently based on the type of issue.\n\nThe required element provides a base level of computable interoperability across all systems for processing an outcome, allowing systems to respond appropriately regardless of the internal system error codes returned.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "OperationOutcome.issue.code",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "IssueType"
}],
"strength" : "required",
"description" : "A code that describes the type of issue.",
"valueSet" : "http://hl7.org/fhir/ValueSet/issue-type|4.0.1"
},
"mapping" : [{
"identity" : "v2",
"map" : "ERR-3"
},
{
"identity" : "rim",
"map" : "./code"
}]
},
{
"id" : "OperationOutcome.issue.details",
"path" : "OperationOutcome.issue.details",
"short" : "Additional details about the error",
"definition" : "Additional details about the error. This may be a text description of the error or a system code that identifies the error.",
"comment" : "A human readable description of the error issue SHOULD be placed in details.text.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "OperationOutcome.issue.details",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "IssueDetails"
}],
"strength" : "example",
"description" : "A code that provides details as the exact issue.",
"valueSet" : "http://hl7.org/fhir/ValueSet/operation-outcome"
},
"mapping" : [{
"identity" : "v2",
"map" : "ERR-5"
},
{
"identity" : "rim",
"map" : "./code"
}]
},
{
"id" : "OperationOutcome.issue.diagnostics",
"path" : "OperationOutcome.issue.diagnostics",
"short" : "Additional diagnostic information about the issue",
"definition" : "Additional diagnostic information about the issue.",
"comment" : "This may be a description of how a value is erroneous, a stack dump to help trace the issue or other troubleshooting information.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "OperationOutcome.issue.diagnostics",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "v2",
"map" : "ERR-8"
},
{
"identity" : "rim",
"map" : "./text[parent::AcknowledgmentDetail]"
}]
},
{
"id" : "OperationOutcome.issue.location",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "deprecated"
}],
"path" : "OperationOutcome.issue.location",
"short" : "Deprecated: Path of element(s) related to issue",
"definition" : "This element is deprecated because it is XML specific. It is replaced by issue.expression, which is format independent, and simpler to parse. \n\nFor resource issues, this will be a simple XPath limited to element names, repetition indicators and the default child accessor that identifies one of the elements in the resource that caused this issue to be raised. For HTTP errors, will be \"http.\" + the parameter name.",
"comment" : "The root of the XPath is the resource or bundle that generated OperationOutcome. Each XPath SHALL resolve to a single node. This element is deprecated, and is being replaced by expression.",
"requirements" : "Allows systems to highlight or otherwise guide users to elements implicated in issues to allow them to be fixed more easily.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "OperationOutcome.issue.location",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "v2",
"map" : "ERR-2"
},
{
"identity" : "rim",
"map" : "./location[parent::AcknowledgmentDetail]"
}]
},
{
"id" : "OperationOutcome.issue.expression",
"path" : "OperationOutcome.issue.expression",
"short" : "FHIRPath of element(s) related to issue",
"definition" : "A [simple subset of FHIRPath](fhirpath.html#simple) limited to element names, repetition indicators and the default child accessor that identifies one of the elements in the resource that caused this issue to be raised.",
"comment" : "The root of the FHIRPath is the resource or bundle that generated OperationOutcome. Each FHIRPath SHALL resolve to a single node.",
"requirements" : "Allows systems to highlight or otherwise guide users to elements implicated in issues to allow them to be fixed more easily.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "OperationOutcome.issue.expression",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "v2",
"map" : "ERR-2"
},
{
"identity" : "rim",
"map" : "./location[parent::AcknowledgmentDetail]"
}]
}]
},
"differential" : {
"element" : [{
"id" : "OperationOutcome",
"path" : "OperationOutcome",
"short" : "Information about the success/failure of an action",
"definition" : "A collection of error, warning, or information messages that result from a system action.",
"comment" : "Can result from the failure of a REST call or be part of the response message returned from a request message.",
"min" : 0,
"max" : "*",
"mapping" : [{
"identity" : "rim",
"map" : "Grouping is handled through multiple repetitions from whatever context references the outcomes (no specific grouper required)"
}]
},
{
"id" : "OperationOutcome.issue",
"path" : "OperationOutcome.issue",
"short" : "A single issue associated with the action",
"definition" : "An error, warning, or information message that results from a system action.",
"min" : 1,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "v2",
"map" : "ERR"
},
{
"identity" : "rim",
"map" : "AcknowledgementDetail or Observation[classCode=\"ALRT\" and moodCode=\"EVN\"]"
}]
},
{
"id" : "OperationOutcome.issue.severity",
"path" : "OperationOutcome.issue.severity",
"short" : "fatal | error | warning | information",
"definition" : "Indicates whether the issue indicates a variation from successful processing.",
"comment" : "This is labeled as \"Is Modifier\" because applications should not confuse hints and warnings with errors.",
"requirements" : "Indicates how relevant the issue is to the overall success of the action.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "IssueSeverity"
}],
"strength" : "required",
"description" : "How the issue affects the success of the action.",
"valueSet" : "http://hl7.org/fhir/ValueSet/issue-severity|4.0.1"
},
"mapping" : [{
"identity" : "v2",
"map" : "ERR-4"
},
{
"identity" : "rim",
"map" : "./typeCode[parent::AcknowledgmentDetail] or unique(./inboundRelationship[parent::Observation and typeCode='SUBJ' and isNormalActRelationship()]/source[classCode=\"OBS\" and moodCode=\"EVN\" and implies(code, ActCode#SEV and isNormalAct())/value[xsi:type=\"CD\"]"
}]
},
{
"id" : "OperationOutcome.issue.code",
"path" : "OperationOutcome.issue.code",
"short" : "Error or warning code",
"definition" : "Describes the type of the issue. The system that creates an OperationOutcome SHALL choose the most applicable code from the IssueType value set, and may additional provide its own code for the error in the details element.",
"requirements" : "Expresses the issue in a human and computer-friendly way, allowing the requesting system to behave differently based on the type of issue.\n\nThe required element provides a base level of computable interoperability across all systems for processing an outcome, allowing systems to respond appropriately regardless of the internal system error codes returned.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "IssueType"
}],
"strength" : "required",
"description" : "A code that describes the type of issue.",
"valueSet" : "http://hl7.org/fhir/ValueSet/issue-type|4.0.1"
},
"mapping" : [{
"identity" : "v2",
"map" : "ERR-3"
},
{
"identity" : "rim",
"map" : "./code"
}]
},
{
"id" : "OperationOutcome.issue.details",
"path" : "OperationOutcome.issue.details",
"short" : "Additional details about the error",
"definition" : "Additional details about the error. This may be a text description of the error or a system code that identifies the error.",
"comment" : "A human readable description of the error issue SHOULD be placed in details.text.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "IssueDetails"
}],
"strength" : "example",
"description" : "A code that provides details as the exact issue.",
"valueSet" : "http://hl7.org/fhir/ValueSet/operation-outcome"
},
"mapping" : [{
"identity" : "v2",
"map" : "ERR-5"
},
{
"identity" : "rim",
"map" : "./code"
}]
},
{
"id" : "OperationOutcome.issue.diagnostics",
"path" : "OperationOutcome.issue.diagnostics",
"short" : "Additional diagnostic information about the issue",
"definition" : "Additional diagnostic information about the issue.",
"comment" : "This may be a description of how a value is erroneous, a stack dump to help trace the issue or other troubleshooting information.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "v2",
"map" : "ERR-8"
},
{
"identity" : "rim",
"map" : "./text[parent::AcknowledgmentDetail]"
}]
},
{
"id" : "OperationOutcome.issue.location",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "deprecated"
}],
"path" : "OperationOutcome.issue.location",
"short" : "Deprecated: Path of element(s) related to issue",
"definition" : "This element is deprecated because it is XML specific. It is replaced by issue.expression, which is format independent, and simpler to parse. \n\nFor resource issues, this will be a simple XPath limited to element names, repetition indicators and the default child accessor that identifies one of the elements in the resource that caused this issue to be raised. For HTTP errors, will be \"http.\" + the parameter name.",
"comment" : "The root of the XPath is the resource or bundle that generated OperationOutcome. Each XPath SHALL resolve to a single node. This element is deprecated, and is being replaced by expression.",
"requirements" : "Allows systems to highlight or otherwise guide users to elements implicated in issues to allow them to be fixed more easily.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "string"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "v2",
"map" : "ERR-2"
},
{
"identity" : "rim",
"map" : "./location[parent::AcknowledgmentDetail]"
}]
},
{
"id" : "OperationOutcome.issue.expression",
"path" : "OperationOutcome.issue.expression",
"short" : "FHIRPath of element(s) related to issue",
"definition" : "A [simple subset of FHIRPath](fhirpath.html#simple) limited to element names, repetition indicators and the default child accessor that identifies one of the elements in the resource that caused this issue to be raised.",
"comment" : "The root of the FHIRPath is the resource or bundle that generated OperationOutcome. Each FHIRPath SHALL resolve to a single node.",
"requirements" : "Allows systems to highlight or otherwise guide users to elements implicated in issues to allow them to be fixed more easily.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "string"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "v2",
"map" : "ERR-2"
},
{
"identity" : "rim",
"map" : "./location[parent::AcknowledgmentDetail]"
}]
}]
}
}
},
{
"fullUrl" : "http://hl7.org/fhir/StructureDefinition/Organization",
"resource" : {
"resourceType" : "StructureDefinition",
"id" : "Organization",
"meta" : {
"lastUpdated" : "2019-11-01T09:29:23.356+11:00"
},
"text" : {
"status" : "generated",
"div" : "Name Flags Card. Type Description & Constraints Organization ITU 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 identifier ΣI 0..* Identifier Identifies this organization across multiple systems
active ?!Σ 0..1 boolean Whether the organization's record is still in active use type Σ 0..* CodeableConcept Kind of organization
Organization type (Example)
name ΣI 0..1 string Name used for the organization alias 0..* string A list of alternate names that the organization is known as, or was known as in the past
telecom I 0..* ContactPoint A contact detail for the organization
+ Rule: The telecom of an organization can never be of use 'home'
address I 0..* Address An address for the organization
+ Rule: An address of an organization can never be of use 'home'
partOf Σ 0..1 Reference(Organization) The organization of which this organization forms a part contact 0..* BackboneElement Contact for the organization for a certain purpose
purpose 0..1 CodeableConcept The type of contact
Contact entity type (Extensible) name 0..1 HumanName A name associated with the contact telecom 0..* ContactPoint Contact details (telephone, email, etc.) for a contact
address 0..1 Address Visiting or postal addresses for the contact endpoint 0..* Reference(Endpoint) Technical endpoints providing access to services operated for the organization
Documentation for this format
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Base.Entities"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 3
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "business"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "pa"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/Organization",
"version" : "4.0.1",
"name" : "Organization",
"status" : "draft",
"date" : "2019-11-01T09:29:23+11:00",
"publisher" : "Health Level Seven International (Patient Administration)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/pafm/index.cfm"
}]
}],
"description" : "A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, payer/insurer, etc.",
"fhirVersion" : "4.0.1",
"mapping" : [{
"identity" : "v2",
"uri" : "http://hl7.org/v2",
"name" : "HL7 v2 Mapping"
},
{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
},
{
"identity" : "servd",
"uri" : "http://www.omg.org/spec/ServD/1.0/",
"name" : "ServD"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/fivews",
"name" : "FiveWs Pattern Mapping"
}],
"kind" : "resource",
"abstract" : false,
"type" : "Organization",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "Organization",
"path" : "Organization",
"short" : "A grouping of people or organizations with a common purpose",
"definition" : "A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, payer/insurer, etc.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Organization",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "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",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.`div`.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "org-1",
"severity" : "error",
"human" : "The organization SHALL at least have a name or an identifier, and possibly more than one",
"expression" : "(identifier.count() + name.count()) > 0",
"xpath" : "count(f:identifier | f:name) > 0"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "v2",
"map" : "(also see master files messages)"
},
{
"identity" : "rim",
"map" : "Organization(classCode=ORG, determinerCode=INST)"
},
{
"identity" : "servd",
"map" : "Organization"
}]
},
{
"id" : "Organization.id",
"path" : "Organization.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Organization.meta",
"path" : "Organization.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Organization.implicitRules",
"path" : "Organization.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "Organization.language",
"path" : "Organization.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "Organization.text",
"path" : "Organization.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "Organization.contained",
"path" : "Organization.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Organization.extension",
"path" : "Organization.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Organization.modifierExtension",
"path" : "Organization.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Organization.identifier",
"path" : "Organization.identifier",
"short" : "Identifies this organization across multiple systems",
"definition" : "Identifier for the organization that is used to identify the organization across multiple disparate systems.",
"requirements" : "Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Organization.identifier",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Identifier"
}],
"condition" : ["org-1"],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "v2",
"map" : "XON.10 / XON.3"
},
{
"identity" : "rim",
"map" : ".scopes[Role](classCode=IDENT)"
},
{
"identity" : "servd",
"map" : "./Identifiers"
}]
},
{
"id" : "Organization.active",
"path" : "Organization.active",
"short" : "Whether the organization's record is still in active use",
"definition" : "Whether the organization's record is still in active use.",
"comment" : "This active flag is not intended to be used to mark an organization as temporarily closed or under construction. Instead the Location(s) within the Organization should have the suspended status. If further details of the reason for the suspension are required, then an extension on this element should be used.\n\nThis element is labeled as a modifier because it may be used to mark that the resource was created in error.",
"requirements" : "Need a flag to indicate a record is no longer to be used and should generally be hidden for the user in the UI.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Organization.active",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"meaningWhenMissing" : "This resource is generally assumed to be active if no value is provided for the active element",
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid",
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.status"
},
{
"identity" : "v2",
"map" : "No equivalent in HL7 v2"
},
{
"identity" : "rim",
"map" : ".status"
},
{
"identity" : "servd",
"map" : "./Status (however this concept in ServD more covers why the organization is active or not, could be delisted, deregistered, not operational yet) this could alternatively be derived from ./StartDate and ./EndDate and given a context date."
}]
},
{
"id" : "Organization.type",
"path" : "Organization.type",
"short" : "Kind of organization",
"definition" : "The kind(s) of organization that this is.",
"comment" : "Organizations can be corporations, wards, sections, clinical teams, government departments, etc. Note that code is generally a classifier of the type of organization; in many applications, codes are used to identity a particular organization (say, ward) as opposed to another of the same type - these are identifiers, not codes\n\nWhen considering if multiple types are appropriate, you should evaluate if child organizations would be a more appropriate use of the concept, as different types likely are in different sub-areas of the organization. This is most likely to be used where type values have orthogonal values, such as a religious, academic and medical center.\n\nWe expect that some jurisdictions will profile this optionality to be a single cardinality.",
"requirements" : "Need to be able to track the kind of organization that this is - different organization types have different uses.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Organization.type",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "OrganizationType"
}],
"strength" : "example",
"description" : "Used to categorize the organization.",
"valueSet" : "http://hl7.org/fhir/ValueSet/organization-type"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.class"
},
{
"identity" : "v2",
"map" : "No equivalent in v2"
},
{
"identity" : "rim",
"map" : ".code"
},
{
"identity" : "servd",
"map" : "n/a"
}]
},
{
"id" : "Organization.name",
"path" : "Organization.name",
"short" : "Name used for the organization",
"definition" : "A name associated with the organization.",
"comment" : "If the name of an organization changes, consider putting the old name in the alias column so that it can still be located through searches.",
"requirements" : "Need to use the name as the label of the organization.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Organization.name",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"condition" : ["org-1"],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "v2",
"map" : "XON.1"
},
{
"identity" : "rim",
"map" : ".name"
},
{
"identity" : "servd",
"map" : ".PreferredName/Name"
}]
},
{
"id" : "Organization.alias",
"path" : "Organization.alias",
"short" : "A list of alternate names that the organization is known as, or was known as in the past",
"definition" : "A list of alternate names that the organization is known as, or was known as in the past.",
"comment" : "There are no dates associated with the alias/historic names, as this is not intended to track when names were used, but to assist in searching so that older names can still result in identifying the organization.",
"requirements" : "Over time locations and organizations go through many changes and can be known by different names.\n\nFor searching knowing previous names that the organization was known by can be very useful.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Organization.alias",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".name"
}]
},
{
"id" : "Organization.telecom",
"path" : "Organization.telecom",
"short" : "A contact detail for the organization",
"definition" : "A contact detail for the organization.",
"comment" : "The use code 'home' is not to be used. Note that these contacts are not the contact details of people who are employed by or represent the organization, but official contacts for the organization itself.",
"requirements" : "Human contact for the organization.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Organization.telecom",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "ContactPoint"
}],
"condition" : ["org-3"],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "org-3",
"severity" : "error",
"human" : "The telecom of an organization can never be of use 'home'",
"expression" : "where(use = 'home').empty()",
"xpath" : "count(f:use[@value='home']) = 0"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "ORC-22?"
},
{
"identity" : "rim",
"map" : ".telecom"
},
{
"identity" : "servd",
"map" : "./ContactPoints"
}]
},
{
"id" : "Organization.address",
"path" : "Organization.address",
"short" : "An address for the organization",
"definition" : "An address for the organization.",
"comment" : "Organization may have multiple addresses with different uses or applicable periods. The use code 'home' is not to be used.",
"requirements" : "May need to keep track of the organization's addresses for contacting, billing or reporting requirements.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Organization.address",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Address"
}],
"condition" : ["org-2"],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "org-2",
"severity" : "error",
"human" : "An address of an organization can never be of use 'home'",
"expression" : "where(use = 'home').empty()",
"xpath" : "count(f:use[@value='home']) = 0"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "ORC-23?"
},
{
"identity" : "rim",
"map" : ".address"
},
{
"identity" : "servd",
"map" : "./PrimaryAddress and ./OtherAddresses"
}]
},
{
"id" : "Organization.partOf",
"path" : "Organization.partOf",
"short" : "The organization of which this organization forms a part",
"definition" : "The organization of which this organization forms a part.",
"requirements" : "Need to be able to track the hierarchy of organizations within an organization.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Organization.partOf",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-hierarchy",
"valueBoolean" : true
}],
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "v2",
"map" : "No equivalent in HL7 v2"
},
{
"identity" : "rim",
"map" : ".playedBy[classCode=Part].scoper"
},
{
"identity" : "servd",
"map" : "n/a"
}]
},
{
"id" : "Organization.contact",
"path" : "Organization.contact",
"short" : "Contact for the organization for a certain purpose",
"definition" : "Contact for the organization for a certain purpose.",
"comment" : "Where multiple contacts for the same purpose are provided there is a standard extension that can be used to determine which one is the preferred contact to use.",
"requirements" : "Need to keep track of assigned contact points within bigger organization.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Organization.contact",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".contactParty"
}]
},
{
"id" : "Organization.contact.id",
"path" : "Organization.contact.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Organization.contact.extension",
"path" : "Organization.contact.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Organization.contact.modifierExtension",
"path" : "Organization.contact.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Organization.contact.purpose",
"path" : "Organization.contact.purpose",
"short" : "The type of contact",
"definition" : "Indicates a purpose for which the contact can be reached.",
"requirements" : "Need to distinguish between multiple contact persons.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Organization.contact.purpose",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ContactPartyType"
}],
"strength" : "extensible",
"description" : "The purpose for which you would contact a contact party.",
"valueSet" : "http://hl7.org/fhir/ValueSet/contactentity-type"
},
"mapping" : [{
"identity" : "rim",
"map" : "./type"
}]
},
{
"id" : "Organization.contact.name",
"path" : "Organization.contact.name",
"short" : "A name associated with the contact",
"definition" : "A name associated with the contact.",
"requirements" : "Need to be able to track the person by name.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Organization.contact.name",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "HumanName"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "PID-5, PID-9"
},
{
"identity" : "rim",
"map" : "./name"
}]
},
{
"id" : "Organization.contact.telecom",
"path" : "Organization.contact.telecom",
"short" : "Contact details (telephone, email, etc.) for a contact",
"definition" : "A contact detail (e.g. a telephone number or an email address) by which the party may be contacted.",
"requirements" : "People have (primary) ways to contact them in some way such as phone, email.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Organization.contact.telecom",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "ContactPoint"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "PID-13, PID-14"
},
{
"identity" : "rim",
"map" : "./telecom"
}]
},
{
"id" : "Organization.contact.address",
"path" : "Organization.contact.address",
"short" : "Visiting or postal addresses for the contact",
"definition" : "Visiting or postal addresses for the contact.",
"requirements" : "May need to keep track of a contact party's address for contacting, billing or reporting requirements.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Organization.contact.address",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Address"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "PID-11"
},
{
"identity" : "rim",
"map" : "./addr"
}]
},
{
"id" : "Organization.endpoint",
"path" : "Organization.endpoint",
"short" : "Technical endpoints providing access to services operated for the organization",
"definition" : "Technical endpoints providing access to services operated for the organization.",
"requirements" : "Organizations have multiple systems that provide various services and need to be able to define the technical connection details for how to connect to them, and for what purpose.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Organization.endpoint",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Endpoint"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
}]
},
"differential" : {
"element" : [{
"id" : "Organization",
"path" : "Organization",
"short" : "A grouping of people or organizations with a common purpose",
"definition" : "A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, payer/insurer, etc.",
"min" : 0,
"max" : "*",
"constraint" : [{
"key" : "org-1",
"severity" : "error",
"human" : "The organization SHALL at least have a name or an identifier, and possibly more than one",
"expression" : "(identifier.count() + name.count()) > 0",
"xpath" : "count(f:identifier | f:name) > 0"
}],
"mapping" : [{
"identity" : "v2",
"map" : "(also see master files messages)"
},
{
"identity" : "rim",
"map" : "Organization(classCode=ORG, determinerCode=INST)"
},
{
"identity" : "servd",
"map" : "Organization"
}]
},
{
"id" : "Organization.identifier",
"path" : "Organization.identifier",
"short" : "Identifies this organization across multiple systems",
"definition" : "Identifier for the organization that is used to identify the organization across multiple disparate systems.",
"requirements" : "Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Identifier"
}],
"condition" : ["org-1"],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "v2",
"map" : "XON.10 / XON.3"
},
{
"identity" : "rim",
"map" : ".scopes[Role](classCode=IDENT)"
},
{
"identity" : "servd",
"map" : "./Identifiers"
}]
},
{
"id" : "Organization.active",
"path" : "Organization.active",
"short" : "Whether the organization's record is still in active use",
"definition" : "Whether the organization's record is still in active use.",
"comment" : "This active flag is not intended to be used to mark an organization as temporarily closed or under construction. Instead the Location(s) within the Organization should have the suspended status. If further details of the reason for the suspension are required, then an extension on this element should be used.\n\nThis element is labeled as a modifier because it may be used to mark that the resource was created in error.",
"requirements" : "Need a flag to indicate a record is no longer to be used and should generally be hidden for the user in the UI.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "boolean"
}],
"meaningWhenMissing" : "This resource is generally assumed to be active if no value is provided for the active element",
"isModifier" : true,
"isModifierReason" : "This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid",
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.status"
},
{
"identity" : "v2",
"map" : "No equivalent in HL7 v2"
},
{
"identity" : "rim",
"map" : ".status"
},
{
"identity" : "servd",
"map" : "./Status (however this concept in ServD more covers why the organization is active or not, could be delisted, deregistered, not operational yet) this could alternatively be derived from ./StartDate and ./EndDate and given a context date."
}]
},
{
"id" : "Organization.type",
"path" : "Organization.type",
"short" : "Kind of organization",
"definition" : "The kind(s) of organization that this is.",
"comment" : "Organizations can be corporations, wards, sections, clinical teams, government departments, etc. Note that code is generally a classifier of the type of organization; in many applications, codes are used to identity a particular organization (say, ward) as opposed to another of the same type - these are identifiers, not codes\n\nWhen considering if multiple types are appropriate, you should evaluate if child organizations would be a more appropriate use of the concept, as different types likely are in different sub-areas of the organization. This is most likely to be used where type values have orthogonal values, such as a religious, academic and medical center.\n\nWe expect that some jurisdictions will profile this optionality to be a single cardinality.",
"requirements" : "Need to be able to track the kind of organization that this is - different organization types have different uses.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "OrganizationType"
}],
"strength" : "example",
"description" : "Used to categorize the organization.",
"valueSet" : "http://hl7.org/fhir/ValueSet/organization-type"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.class"
},
{
"identity" : "v2",
"map" : "No equivalent in v2"
},
{
"identity" : "rim",
"map" : ".code"
},
{
"identity" : "servd",
"map" : "n/a"
}]
},
{
"id" : "Organization.name",
"path" : "Organization.name",
"short" : "Name used for the organization",
"definition" : "A name associated with the organization.",
"comment" : "If the name of an organization changes, consider putting the old name in the alias column so that it can still be located through searches.",
"requirements" : "Need to use the name as the label of the organization.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"condition" : ["org-1"],
"isSummary" : true,
"mapping" : [{
"identity" : "v2",
"map" : "XON.1"
},
{
"identity" : "rim",
"map" : ".name"
},
{
"identity" : "servd",
"map" : ".PreferredName/Name"
}]
},
{
"id" : "Organization.alias",
"path" : "Organization.alias",
"short" : "A list of alternate names that the organization is known as, or was known as in the past",
"definition" : "A list of alternate names that the organization is known as, or was known as in the past.",
"comment" : "There are no dates associated with the alias/historic names, as this is not intended to track when names were used, but to assist in searching so that older names can still result in identifying the organization.",
"requirements" : "Over time locations and organizations go through many changes and can be known by different names.\n\nFor searching knowing previous names that the organization was known by can be very useful.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "string"
}],
"mapping" : [{
"identity" : "rim",
"map" : ".name"
}]
},
{
"id" : "Organization.telecom",
"path" : "Organization.telecom",
"short" : "A contact detail for the organization",
"definition" : "A contact detail for the organization.",
"comment" : "The use code 'home' is not to be used. Note that these contacts are not the contact details of people who are employed by or represent the organization, but official contacts for the organization itself.",
"requirements" : "Human contact for the organization.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "ContactPoint"
}],
"condition" : ["org-3"],
"constraint" : [{
"key" : "org-3",
"severity" : "error",
"human" : "The telecom of an organization can never be of use 'home'",
"expression" : "where(use = 'home').empty()",
"xpath" : "count(f:use[@value='home']) = 0"
}],
"mapping" : [{
"identity" : "v2",
"map" : "ORC-22?"
},
{
"identity" : "rim",
"map" : ".telecom"
},
{
"identity" : "servd",
"map" : "./ContactPoints"
}]
},
{
"id" : "Organization.address",
"path" : "Organization.address",
"short" : "An address for the organization",
"definition" : "An address for the organization.",
"comment" : "Organization may have multiple addresses with different uses or applicable periods. The use code 'home' is not to be used.",
"requirements" : "May need to keep track of the organization's addresses for contacting, billing or reporting requirements.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Address"
}],
"condition" : ["org-2"],
"constraint" : [{
"key" : "org-2",
"severity" : "error",
"human" : "An address of an organization can never be of use 'home'",
"expression" : "where(use = 'home').empty()",
"xpath" : "count(f:use[@value='home']) = 0"
}],
"mapping" : [{
"identity" : "v2",
"map" : "ORC-23?"
},
{
"identity" : "rim",
"map" : ".address"
},
{
"identity" : "servd",
"map" : "./PrimaryAddress and ./OtherAddresses"
}]
},
{
"id" : "Organization.partOf",
"path" : "Organization.partOf",
"short" : "The organization of which this organization forms a part",
"definition" : "The organization of which this organization forms a part.",
"requirements" : "Need to be able to track the hierarchy of organizations within an organization.",
"min" : 0,
"max" : "1",
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-hierarchy",
"valueBoolean" : true
}],
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "v2",
"map" : "No equivalent in HL7 v2"
},
{
"identity" : "rim",
"map" : ".playedBy[classCode=Part].scoper"
},
{
"identity" : "servd",
"map" : "n/a"
}]
},
{
"id" : "Organization.contact",
"path" : "Organization.contact",
"short" : "Contact for the organization for a certain purpose",
"definition" : "Contact for the organization for a certain purpose.",
"comment" : "Where multiple contacts for the same purpose are provided there is a standard extension that can be used to determine which one is the preferred contact to use.",
"requirements" : "Need to keep track of assigned contact points within bigger organization.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"mapping" : [{
"identity" : "rim",
"map" : ".contactParty"
}]
},
{
"id" : "Organization.contact.purpose",
"path" : "Organization.contact.purpose",
"short" : "The type of contact",
"definition" : "Indicates a purpose for which the contact can be reached.",
"requirements" : "Need to distinguish between multiple contact persons.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ContactPartyType"
}],
"strength" : "extensible",
"description" : "The purpose for which you would contact a contact party.",
"valueSet" : "http://hl7.org/fhir/ValueSet/contactentity-type"
},
"mapping" : [{
"identity" : "rim",
"map" : "./type"
}]
},
{
"id" : "Organization.contact.name",
"path" : "Organization.contact.name",
"short" : "A name associated with the contact",
"definition" : "A name associated with the contact.",
"requirements" : "Need to be able to track the person by name.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "HumanName"
}],
"mapping" : [{
"identity" : "v2",
"map" : "PID-5, PID-9"
},
{
"identity" : "rim",
"map" : "./name"
}]
},
{
"id" : "Organization.contact.telecom",
"path" : "Organization.contact.telecom",
"short" : "Contact details (telephone, email, etc.) for a contact",
"definition" : "A contact detail (e.g. a telephone number or an email address) by which the party may be contacted.",
"requirements" : "People have (primary) ways to contact them in some way such as phone, email.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "ContactPoint"
}],
"mapping" : [{
"identity" : "v2",
"map" : "PID-13, PID-14"
},
{
"identity" : "rim",
"map" : "./telecom"
}]
},
{
"id" : "Organization.contact.address",
"path" : "Organization.contact.address",
"short" : "Visiting or postal addresses for the contact",
"definition" : "Visiting or postal addresses for the contact.",
"requirements" : "May need to keep track of a contact party's address for contacting, billing or reporting requirements.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Address"
}],
"mapping" : [{
"identity" : "v2",
"map" : "PID-11"
},
{
"identity" : "rim",
"map" : "./addr"
}]
},
{
"id" : "Organization.endpoint",
"path" : "Organization.endpoint",
"short" : "Technical endpoints providing access to services operated for the organization",
"definition" : "Technical endpoints providing access to services operated for the organization.",
"requirements" : "Organizations have multiple systems that provide various services and need to be able to define the technical connection details for how to connect to them, and for what purpose.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Endpoint"]
}],
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
}]
}
}
},
{
"fullUrl" : "http://hl7.org/fhir/StructureDefinition/OrganizationAffiliation",
"resource" : {
"resourceType" : "StructureDefinition",
"id" : "OrganizationAffiliation",
"meta" : {
"lastUpdated" : "2019-11-01T09:29:23.356+11:00"
},
"text" : {
"status" : "generated",
"div" : "Name Flags Card. Type Description & Constraints OrganizationAffiliation TU DomainResource Defines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension identifier Σ 0..* Identifier Business identifiers that are specific to this role
active Σ 0..1 boolean Whether this organization affiliation record is in active use period Σ 0..1 Period The period during which the participatingOrganization is affiliated with the primary organization organization Σ 0..1 Reference(Organization) Organization where the role is available participatingOrganization Σ 0..1 Reference(Organization) Organization that provides/performs the role (e.g. providing services or is a member of) network Σ 0..* Reference(Organization) Health insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined)
code Σ 0..* CodeableConcept Definition of the role the participatingOrganization plays
Organization Affiliation Role (Example)
specialty Σ 0..* CodeableConcept Specific specialty of the participatingOrganization in the context of the role
Practice Setting Code Value Set (Preferred)
location Σ 0..* Reference(Location) The location(s) at which the role occurs
healthcareService 0..* Reference(HealthcareService) Healthcare services provided through the role
telecom Σ 0..* ContactPoint Contact details at the participatingOrganization relevant to this Affiliation
endpoint 0..* Reference(Endpoint) Technical endpoints providing access to services operated for this role
Documentation for this format
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Base.Entities"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 0
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "business"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "pa"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/OrganizationAffiliation",
"version" : "4.0.1",
"name" : "OrganizationAffiliation",
"status" : "draft",
"date" : "2019-11-01T09:29:23+11:00",
"publisher" : "Health Level Seven International (Patient Administration)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/pafm/index.cfm"
}]
}],
"description" : "Defines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship.",
"purpose" : "Need to define relationships between organizations that are not sub-divisions of the same organization (part-of relationships).",
"fhirVersion" : "4.0.1",
"mapping" : [{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/fivews",
"name" : "FiveWs Pattern Mapping"
}],
"kind" : "resource",
"abstract" : false,
"type" : "OrganizationAffiliation",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "OrganizationAffiliation",
"path" : "OrganizationAffiliation",
"short" : "Defines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship",
"definition" : "Defines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "OrganizationAffiliation",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "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",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.`div`.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "rim",
"map" : "Role"
}]
},
{
"id" : "OrganizationAffiliation.id",
"path" : "OrganizationAffiliation.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "OrganizationAffiliation.meta",
"path" : "OrganizationAffiliation.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "OrganizationAffiliation.implicitRules",
"path" : "OrganizationAffiliation.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "OrganizationAffiliation.language",
"path" : "OrganizationAffiliation.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "OrganizationAffiliation.text",
"path" : "OrganizationAffiliation.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "OrganizationAffiliation.contained",
"path" : "OrganizationAffiliation.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "OrganizationAffiliation.extension",
"path" : "OrganizationAffiliation.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "OrganizationAffiliation.modifierExtension",
"path" : "OrganizationAffiliation.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "OrganizationAffiliation.identifier",
"path" : "OrganizationAffiliation.identifier",
"short" : "Business identifiers that are specific to this role",
"definition" : "Business identifiers that are specific to this role.",
"requirements" : "Often, specific identities are assigned for the agent.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "OrganizationAffiliation.identifier",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Identifier"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "rim",
"map" : ".id"
}]
},
{
"id" : "OrganizationAffiliation.active",
"path" : "OrganizationAffiliation.active",
"short" : "Whether this organization affiliation record is in active use",
"definition" : "Whether this organization affiliation record is in active use.",
"comment" : "If this value is false, you may refer to the period to see when the role was in active use. If there is no period specified, no inference can be made about when it was active.",
"requirements" : "Need to be able to mark an organization affiliation record as not to be used because it was created in error, or otherwise no longer in active use.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "OrganizationAffiliation.active",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"meaningWhenMissing" : "This resource is generally assumed to be active if no value is provided for the active element",
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.status"
},
{
"identity" : "rim",
"map" : ".statusCode"
}]
},
{
"id" : "OrganizationAffiliation.period",
"path" : "OrganizationAffiliation.period",
"short" : "The period during which the participatingOrganization is affiliated with the primary organization",
"definition" : "The period during which the participatingOrganization is affiliated with the primary organization.",
"requirements" : "An affiliation may be created ahead of time and only be active for a defined period of time. Once the affiliation is complete, the fact that it existed may still be required.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "OrganizationAffiliation.period",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Period"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.done[x]"
},
{
"identity" : "rim",
"map" : ".performance[@typeCode <= 'PPRF'].ActDefinitionOrEvent.effectiveTime"
}]
},
{
"id" : "OrganizationAffiliation.organization",
"path" : "OrganizationAffiliation.organization",
"short" : "Organization where the role is available",
"definition" : "Organization where the role is available (primary organization/has members).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "OrganizationAffiliation.organization",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : ".scoper"
}]
},
{
"id" : "OrganizationAffiliation.participatingOrganization",
"path" : "OrganizationAffiliation.participatingOrganization",
"short" : "Organization that provides/performs the role (e.g. providing services or is a member of)",
"definition" : "The Participating Organization provides/performs the role(s) defined by the code to the Primary Organization (e.g. providing services or is a member of).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "OrganizationAffiliation.participatingOrganization",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : ".player"
}]
},
{
"id" : "OrganizationAffiliation.network",
"path" : "OrganizationAffiliation.network",
"short" : "Health insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined)",
"definition" : "Health insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined).",
"min" : 0,
"max" : "*",
"base" : {
"path" : "OrganizationAffiliation.network",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "OrganizationAffiliation.code",
"path" : "OrganizationAffiliation.code",
"short" : "Definition of the role the participatingOrganization plays",
"definition" : "Definition of the role the participatingOrganization plays in the association.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "OrganizationAffiliation.code",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "OrganizationAffiliation"
}],
"strength" : "example",
"description" : "The role the participating organization providing services to the primary organization.",
"valueSet" : "http://hl7.org/fhir/ValueSet/organization-role"
},
"mapping" : [{
"identity" : "rim",
"map" : ".code"
}]
},
{
"id" : "OrganizationAffiliation.specialty",
"path" : "OrganizationAffiliation.specialty",
"short" : "Specific specialty of the participatingOrganization in the context of the role",
"definition" : "Specific specialty of the participatingOrganization in the context of the role.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "OrganizationAffiliation.specialty",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "OrganizationSpecialty"
}],
"strength" : "preferred",
"description" : "Specific specialty associated with the participating organization.",
"valueSet" : "http://hl7.org/fhir/ValueSet/c80-practice-codes"
},
"mapping" : [{
"identity" : "rim",
"map" : ".player.HealthCareProvider[@classCode = 'PROV'].code"
}]
},
{
"id" : "OrganizationAffiliation.location",
"path" : "OrganizationAffiliation.location",
"short" : "The location(s) at which the role occurs",
"definition" : "The location(s) at which the role occurs.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "OrganizationAffiliation.location",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Location"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.where[x]"
},
{
"identity" : "rim",
"map" : ".performance.ActDefinitionOrEvent.ServiceDeliveryLocation[@classCode = 'SDLOC']"
}]
},
{
"id" : "OrganizationAffiliation.healthcareService",
"path" : "OrganizationAffiliation.healthcareService",
"short" : "Healthcare services provided through the role",
"definition" : "Healthcare services provided through the role.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "OrganizationAffiliation.healthcareService",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/HealthcareService"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".player.QualifiedEntity[@classCode = 'QUAL'].code"
}]
},
{
"id" : "OrganizationAffiliation.telecom",
"path" : "OrganizationAffiliation.telecom",
"short" : "Contact details at the participatingOrganization relevant to this Affiliation",
"definition" : "Contact details at the participatingOrganization relevant to this Affiliation.",
"requirements" : "Sometimes a participating organization provides dedicated contacts to handle enquiries specifically for the role provided to the affiliated organization.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "OrganizationAffiliation.telecom",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "ContactPoint"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : ".telecom"
}]
},
{
"id" : "OrganizationAffiliation.endpoint",
"path" : "OrganizationAffiliation.endpoint",
"short" : "Technical endpoints providing access to services operated for this role",
"definition" : "Technical endpoints providing access to services operated for this role.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "OrganizationAffiliation.endpoint",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Endpoint"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
}]
},
"differential" : {
"element" : [{
"id" : "OrganizationAffiliation",
"path" : "OrganizationAffiliation",
"short" : "Defines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship",
"definition" : "Defines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship.",
"min" : 0,
"max" : "*",
"mapping" : [{
"identity" : "rim",
"map" : "Role"
}]
},
{
"id" : "OrganizationAffiliation.identifier",
"path" : "OrganizationAffiliation.identifier",
"short" : "Business identifiers that are specific to this role",
"definition" : "Business identifiers that are specific to this role.",
"requirements" : "Often, specific identities are assigned for the agent.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Identifier"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "rim",
"map" : ".id"
}]
},
{
"id" : "OrganizationAffiliation.active",
"path" : "OrganizationAffiliation.active",
"short" : "Whether this organization affiliation record is in active use",
"definition" : "Whether this organization affiliation record is in active use.",
"comment" : "If this value is false, you may refer to the period to see when the role was in active use. If there is no period specified, no inference can be made about when it was active.",
"requirements" : "Need to be able to mark an organization affiliation record as not to be used because it was created in error, or otherwise no longer in active use.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "boolean"
}],
"meaningWhenMissing" : "This resource is generally assumed to be active if no value is provided for the active element",
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.status"
},
{
"identity" : "rim",
"map" : ".statusCode"
}]
},
{
"id" : "OrganizationAffiliation.period",
"path" : "OrganizationAffiliation.period",
"short" : "The period during which the participatingOrganization is affiliated with the primary organization",
"definition" : "The period during which the participatingOrganization is affiliated with the primary organization.",
"requirements" : "An affiliation may be created ahead of time and only be active for a defined period of time. Once the affiliation is complete, the fact that it existed may still be required.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Period"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.done[x]"
},
{
"identity" : "rim",
"map" : ".performance[@typeCode <= 'PPRF'].ActDefinitionOrEvent.effectiveTime"
}]
},
{
"id" : "OrganizationAffiliation.organization",
"path" : "OrganizationAffiliation.organization",
"short" : "Organization where the role is available",
"definition" : "Organization where the role is available (primary organization/has members).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : ".scoper"
}]
},
{
"id" : "OrganizationAffiliation.participatingOrganization",
"path" : "OrganizationAffiliation.participatingOrganization",
"short" : "Organization that provides/performs the role (e.g. providing services or is a member of)",
"definition" : "The Participating Organization provides/performs the role(s) defined by the code to the Primary Organization (e.g. providing services or is a member of).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : ".player"
}]
},
{
"id" : "OrganizationAffiliation.network",
"path" : "OrganizationAffiliation.network",
"short" : "Health insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined)",
"definition" : "Health insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined).",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"isSummary" : true
},
{
"id" : "OrganizationAffiliation.code",
"path" : "OrganizationAffiliation.code",
"short" : "Definition of the role the participatingOrganization plays",
"definition" : "Definition of the role the participatingOrganization plays in the association.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "OrganizationAffiliation"
}],
"strength" : "example",
"description" : "The role the participating organization providing services to the primary organization.",
"valueSet" : "http://hl7.org/fhir/ValueSet/organization-role"
},
"mapping" : [{
"identity" : "rim",
"map" : ".code"
}]
},
{
"id" : "OrganizationAffiliation.specialty",
"path" : "OrganizationAffiliation.specialty",
"short" : "Specific specialty of the participatingOrganization in the context of the role",
"definition" : "Specific specialty of the participatingOrganization in the context of the role.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "OrganizationSpecialty"
}],
"strength" : "preferred",
"description" : "Specific specialty associated with the participating organization.",
"valueSet" : "http://hl7.org/fhir/ValueSet/c80-practice-codes"
},
"mapping" : [{
"identity" : "rim",
"map" : ".player.HealthCareProvider[@classCode = 'PROV'].code"
}]
},
{
"id" : "OrganizationAffiliation.location",
"path" : "OrganizationAffiliation.location",
"short" : "The location(s) at which the role occurs",
"definition" : "The location(s) at which the role occurs.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Location"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.where[x]"
},
{
"identity" : "rim",
"map" : ".performance.ActDefinitionOrEvent.ServiceDeliveryLocation[@classCode = 'SDLOC']"
}]
},
{
"id" : "OrganizationAffiliation.healthcareService",
"path" : "OrganizationAffiliation.healthcareService",
"short" : "Healthcare services provided through the role",
"definition" : "Healthcare services provided through the role.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/HealthcareService"]
}],
"mapping" : [{
"identity" : "rim",
"map" : ".player.QualifiedEntity[@classCode = 'QUAL'].code"
}]
},
{
"id" : "OrganizationAffiliation.telecom",
"path" : "OrganizationAffiliation.telecom",
"short" : "Contact details at the participatingOrganization relevant to this Affiliation",
"definition" : "Contact details at the participatingOrganization relevant to this Affiliation.",
"requirements" : "Sometimes a participating organization provides dedicated contacts to handle enquiries specifically for the role provided to the affiliated organization.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "ContactPoint"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : ".telecom"
}]
},
{
"id" : "OrganizationAffiliation.endpoint",
"path" : "OrganizationAffiliation.endpoint",
"short" : "Technical endpoints providing access to services operated for this role",
"definition" : "Technical endpoints providing access to services operated for this role.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Endpoint"]
}],
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
}]
}
}
},
{
"fullUrl" : "http://hl7.org/fhir/StructureDefinition/Parameters",
"resource" : {
"resourceType" : "StructureDefinition",
"id" : "Parameters",
"meta" : {
"lastUpdated" : "2019-11-01T09:29:23.356+11:00"
},
"text" : {
"status" : "generated",
"div" : "Name Flags Card. Type Description & Constraints Parameters ΣN Resource Operation Request or Response
Elements defined in Ancestors: id, meta, implicitRules, language parameter ΣI 0..* BackboneElement Operation Parameter
+ Rule: A parameter must have one and only one of (value, resource, part)
name Σ 1..1 string Name from the definition value[x] ΣI 0..1 * If parameter is a data type resource ΣI 0..1 Resource If parameter is a whole resource part Σ 0..* see parameter Named part of a multi-part parameter
Documentation for this format
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Foundation.Other"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "normative"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode" : "4.0.0"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 5
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "fhir"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/Parameters",
"version" : "4.0.1",
"name" : "Parameters",
"status" : "active",
"date" : "2019-11-01T09:29:23+11:00",
"publisher" : "Health Level Seven International (FHIR Infrastructure)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/fiwg/index.cfm"
}]
}],
"description" : "This resource is a non-persisted resource used to pass information into and back from an [operation](operations.html). It has no other use, and there is no RESTful endpoint associated with it.",
"fhirVersion" : "4.0.1",
"mapping" : [{
"identity" : "v2",
"uri" : "http://hl7.org/v2",
"name" : "HL7 v2 Mapping"
},
{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
}],
"kind" : "resource",
"abstract" : false,
"type" : "Parameters",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/Resource",
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "Parameters",
"path" : "Parameters",
"short" : "Operation Request or Response",
"definition" : "This resource is a non-persisted resource used to pass information into and back from an [operation](operations.html). It has no other use, and there is no RESTful endpoint associated with it.",
"comment" : "The parameters that may be used are defined by the OperationDefinition resource.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Parameters",
"min" : 0,
"max" : "*"
},
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "v2",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Parameters.id",
"path" : "Parameters.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Parameters.meta",
"path" : "Parameters.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Parameters.implicitRules",
"path" : "Parameters.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "Parameters.language",
"path" : "Parameters.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "Parameters.parameter",
"path" : "Parameters.parameter",
"short" : "Operation Parameter",
"definition" : "A parameter passed to or received from the operation.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Parameters.parameter",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "inv-1",
"severity" : "error",
"human" : "A parameter must have one and only one of (value, resource, part)",
"expression" : "(part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))",
"xpath" : "(exists(f:resource) or exists(f:part) or exists(f:*[starts-with(local-name(.), 'value')])) and not(exists(f:*[starts-with(local-name(.), 'value')])) and exists(f:resource))) and not(exists(f:*[starts-with(local-name(.), 'value')])) and exists(f:part))) and not(exists(f:part) and exists(f:resource))"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Parameters.parameter.id",
"path" : "Parameters.parameter.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Parameters.parameter.extension",
"path" : "Parameters.parameter.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Parameters.parameter.modifierExtension",
"path" : "Parameters.parameter.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Parameters.parameter.name",
"path" : "Parameters.parameter.name",
"short" : "Name from the definition",
"definition" : "The name of the parameter (reference to the operation definition).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Parameters.parameter.name",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Parameters.parameter.value[x]",
"path" : "Parameters.parameter.value[x]",
"short" : "If parameter is a data type",
"definition" : "If the parameter is a data type.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Parameters.parameter.value[x]",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "base64Binary"
},
{
"code" : "boolean"
},
{
"code" : "canonical"
},
{
"code" : "code"
},
{
"code" : "date"
},
{
"code" : "dateTime"
},
{
"code" : "decimal"
},
{
"code" : "id"
},
{
"code" : "instant"
},
{
"code" : "integer"
},
{
"code" : "markdown"
},
{
"code" : "oid"
},
{
"code" : "positiveInt"
},
{
"code" : "string"
},
{
"code" : "time"
},
{
"code" : "unsignedInt"
},
{
"code" : "uri"
},
{
"code" : "url"
},
{
"code" : "uuid"
},
{
"code" : "Address"
},
{
"code" : "Age"
},
{
"code" : "Annotation"
},
{
"code" : "Attachment"
},
{
"code" : "CodeableConcept"
},
{
"code" : "Coding"
},
{
"code" : "ContactPoint"
},
{
"code" : "Count"
},
{
"code" : "Distance"
},
{
"code" : "Duration"
},
{
"code" : "HumanName"
},
{
"code" : "Identifier"
},
{
"code" : "Money"
},
{
"code" : "Period"
},
{
"code" : "Quantity"
},
{
"code" : "Range"
},
{
"code" : "Ratio"
},
{
"code" : "Reference"
},
{
"code" : "SampledData"
},
{
"code" : "Signature"
},
{
"code" : "Timing"
},
{
"code" : "ContactDetail"
},
{
"code" : "Contributor"
},
{
"code" : "DataRequirement"
},
{
"code" : "Expression"
},
{
"code" : "ParameterDefinition"
},
{
"code" : "RelatedArtifact"
},
{
"code" : "TriggerDefinition"
},
{
"code" : "UsageContext"
},
{
"code" : "Dosage"
},
{
"code" : "Meta"
}],
"condition" : ["inv-1"],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Parameters.parameter.resource",
"path" : "Parameters.parameter.resource",
"short" : "If parameter is a whole resource",
"definition" : "If the parameter is a whole resource.",
"comment" : "When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to it's general resource resolution methods.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Parameters.parameter.resource",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Resource"
}],
"condition" : ["inv-1"],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Parameters.parameter.part",
"path" : "Parameters.parameter.part",
"short" : "Named part of a multi-part parameter",
"definition" : "A named part of a multi-part parameter.",
"comment" : "Only one level of nested parameters is allowed.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Parameters.parameter.part",
"min" : 0,
"max" : "*"
},
"contentReference" : "#Parameters.parameter",
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
}]
},
"differential" : {
"element" : [{
"id" : "Parameters",
"path" : "Parameters",
"short" : "Operation Request or Response",
"definition" : "This resource is a non-persisted resource used to pass information into and back from an [operation](operations.html). It has no other use, and there is no RESTful endpoint associated with it.",
"comment" : "The parameters that may be used are defined by the OperationDefinition resource.",
"min" : 0,
"max" : "*",
"mapping" : [{
"identity" : "v2",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Parameters.parameter",
"path" : "Parameters.parameter",
"short" : "Operation Parameter",
"definition" : "A parameter passed to or received from the operation.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "inv-1",
"severity" : "error",
"human" : "A parameter must have one and only one of (value, resource, part)",
"expression" : "(part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))",
"xpath" : "(exists(f:resource) or exists(f:part) or exists(f:*[starts-with(local-name(.), 'value')])) and not(exists(f:*[starts-with(local-name(.), 'value')])) and exists(f:resource))) and not(exists(f:*[starts-with(local-name(.), 'value')])) and exists(f:part))) and not(exists(f:part) and exists(f:resource))"
}],
"isSummary" : true
},
{
"id" : "Parameters.parameter.name",
"path" : "Parameters.parameter.name",
"short" : "Name from the definition",
"definition" : "The name of the parameter (reference to the operation definition).",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "Parameters.parameter.value[x]",
"path" : "Parameters.parameter.value[x]",
"short" : "If parameter is a data type",
"definition" : "If the parameter is a data type.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "base64Binary"
},
{
"code" : "boolean"
},
{
"code" : "canonical"
},
{
"code" : "code"
},
{
"code" : "date"
},
{
"code" : "dateTime"
},
{
"code" : "decimal"
},
{
"code" : "id"
},
{
"code" : "instant"
},
{
"code" : "integer"
},
{
"code" : "markdown"
},
{
"code" : "oid"
},
{
"code" : "positiveInt"
},
{
"code" : "string"
},
{
"code" : "time"
},
{
"code" : "unsignedInt"
},
{
"code" : "uri"
},
{
"code" : "url"
},
{
"code" : "uuid"
},
{
"code" : "Address"
},
{
"code" : "Age"
},
{
"code" : "Annotation"
},
{
"code" : "Attachment"
},
{
"code" : "CodeableConcept"
},
{
"code" : "Coding"
},
{
"code" : "ContactPoint"
},
{
"code" : "Count"
},
{
"code" : "Distance"
},
{
"code" : "Duration"
},
{
"code" : "HumanName"
},
{
"code" : "Identifier"
},
{
"code" : "Money"
},
{
"code" : "Period"
},
{
"code" : "Quantity"
},
{
"code" : "Range"
},
{
"code" : "Ratio"
},
{
"code" : "Reference"
},
{
"code" : "SampledData"
},
{
"code" : "Signature"
},
{
"code" : "Timing"
},
{
"code" : "ContactDetail"
},
{
"code" : "Contributor"
},
{
"code" : "DataRequirement"
},
{
"code" : "Expression"
},
{
"code" : "ParameterDefinition"
},
{
"code" : "RelatedArtifact"
},
{
"code" : "TriggerDefinition"
},
{
"code" : "UsageContext"
},
{
"code" : "Dosage"
},
{
"code" : "Meta"
}],
"condition" : ["inv-1"],
"isSummary" : true
},
{
"id" : "Parameters.parameter.resource",
"path" : "Parameters.parameter.resource",
"short" : "If parameter is a whole resource",
"definition" : "If the parameter is a whole resource.",
"comment" : "When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to it's general resource resolution methods.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Resource"
}],
"condition" : ["inv-1"],
"isSummary" : true
},
{
"id" : "Parameters.parameter.part",
"path" : "Parameters.parameter.part",
"short" : "Named part of a multi-part parameter",
"definition" : "A named part of a multi-part parameter.",
"comment" : "Only one level of nested parameters is allowed.",
"min" : 0,
"max" : "*",
"contentReference" : "#Parameters.parameter",
"isSummary" : true
}]
}
}
},
{
"fullUrl" : "http://hl7.org/fhir/StructureDefinition/Patient",
"resource" : {
"resourceType" : "StructureDefinition",
"id" : "Patient",
"meta" : {
"lastUpdated" : "2019-11-01T09:29:23.356+11:00"
},
"text" : {
"status" : "generated",
"div" : "Name Flags Card. Type Description & Constraints Patient N DomainResource Information about an individual or animal receiving health care services
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension identifier Σ 0..* Identifier An identifier for this patient
active ?!Σ 0..1 boolean Whether this patient's record is in active use name Σ 0..* HumanName A name associated with the patient
telecom Σ 0..* ContactPoint A contact detail for the individual
gender Σ 0..1 code male | female | other | unknown
AdministrativeGender (Required) birthDate Σ 0..1 date The date of birth for the individual deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not deceasedBoolean boolean deceasedDateTime dateTime address Σ 0..* Address An address for the individual
maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
MaritalStatus (Extensible) multipleBirth[x] 0..1 Whether patient is part of a multiple birth multipleBirthBoolean boolean multipleBirthInteger integer photo 0..* Attachment Image of the patient
contact I 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
relationship 0..* CodeableConcept The kind of relationship
Patient Contact Relationship (Extensible)
name 0..1 HumanName A name associated with the contact person telecom 0..* ContactPoint A contact detail for the person
address 0..1 Address Address for the contact person gender 0..1 code male | female | other | unknown
AdministrativeGender (Required) organization I 0..1 Reference(Organization) Organization that is associated with the contact period 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient communication 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
language 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Common Languages (Preferred but limited to AllLanguages) preferred 0..1 boolean Language preference indicator generalPractitioner 0..* Reference(Organization | Practitioner | PractitionerRole) Patient's nominated primary care provider
managingOrganization Σ 0..1 Reference(Organization) Organization that is the custodian of the patient record link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
other Σ 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to type Σ 1..1 code replaced-by | replaces | refer | seealso
LinkType (Required)
Documentation for this format
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Base.Individuals"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "normative"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode" : "4.0.0"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 5
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "patient"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "pa"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/Patient",
"version" : "4.0.1",
"name" : "Patient",
"status" : "active",
"date" : "2019-11-01T09:29:23+11:00",
"publisher" : "Health Level Seven International (Patient Administration)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/pafm/index.cfm"
}]
}],
"description" : "Demographics and other administrative information about an individual or animal receiving care or other health-related services.",
"purpose" : "Tracking patient is the center of the healthcare process.",
"fhirVersion" : "4.0.1",
"mapping" : [{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
},
{
"identity" : "cda",
"uri" : "http://hl7.org/v3/cda",
"name" : "CDA (R2)"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/fivews",
"name" : "FiveWs Pattern Mapping"
},
{
"identity" : "v2",
"uri" : "http://hl7.org/v2",
"name" : "HL7 v2 Mapping"
},
{
"identity" : "loinc",
"uri" : "http://loinc.org",
"name" : "LOINC code for the element"
}],
"kind" : "resource",
"abstract" : false,
"type" : "Patient",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "Patient",
"path" : "Patient",
"short" : "Information about an individual or animal receiving health care services",
"definition" : "Demographics and other administrative information about an individual or animal receiving care or other health-related services.",
"alias" : ["SubjectOfCare Client Resident"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Patient",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "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",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.`div`.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "rim",
"map" : "Patient[classCode=PAT]"
},
{
"identity" : "cda",
"map" : "ClinicalDocument.recordTarget.patientRole"
}]
},
{
"id" : "Patient.id",
"path" : "Patient.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Patient.meta",
"path" : "Patient.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Patient.implicitRules",
"path" : "Patient.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "Patient.language",
"path" : "Patient.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "Patient.text",
"path" : "Patient.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "Patient.contained",
"path" : "Patient.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Patient.extension",
"path" : "Patient.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Patient.modifierExtension",
"path" : "Patient.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Patient.identifier",
"path" : "Patient.identifier",
"short" : "An identifier for this patient",
"definition" : "An identifier for this patient.",
"requirements" : "Patients are almost always assigned specific numerical identifiers.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Patient.identifier",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Identifier"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "v2",
"map" : "PID-3"
},
{
"identity" : "rim",
"map" : "id"
},
{
"identity" : "cda",
"map" : ".id"
}]
},
{
"id" : "Patient.active",
"path" : "Patient.active",
"short" : "Whether this patient's record is in active use",
"definition" : "Whether this patient record is in active use. \nMany systems use this property to mark as non-current patients, such as those that have not been seen for a period of time based on an organization's business rules.\n\nIt is often used to filter patient lists to exclude inactive patients\n\nDeceased patients may also be marked as inactive for the same reasons, but may be active for some time after death.",
"comment" : "If a record is inactive, and linked to an active record, then future patient/record updates should occur on the other patient.",
"requirements" : "Need to be able to mark a patient record as not to be used because it was created in error.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Patient.active",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"meaningWhenMissing" : "This resource is generally assumed to be active if no value is provided for the active element",
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid",
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.status"
},
{
"identity" : "rim",
"map" : "statusCode"
},
{
"identity" : "cda",
"map" : "n/a"
}]
},
{
"id" : "Patient.name",
"path" : "Patient.name",
"short" : "A name associated with the patient",
"definition" : "A name associated with the individual.",
"comment" : "A patient may have multiple names with different uses or applicable periods. For animals, the name is a \"HumanName\" in the sense that is assigned and used by humans and has the same patterns.",
"requirements" : "Need to be able to track the patient by multiple names. Examples are your official name and a partner name.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Patient.name",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "HumanName"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "v2",
"map" : "PID-5, PID-9"
},
{
"identity" : "rim",
"map" : "name"
},
{
"identity" : "cda",
"map" : ".patient.name"
}]
},
{
"id" : "Patient.telecom",
"path" : "Patient.telecom",
"short" : "A contact detail for the individual",
"definition" : "A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.",
"comment" : "A Patient may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and also to help with identification. The address might not go directly to the individual, but may reach another party that is able to proxy for the patient (i.e. home phone, or pet owner's phone).",
"requirements" : "People have (primary) ways to contact them in some way such as phone, email.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Patient.telecom",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "ContactPoint"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "v2",
"map" : "PID-13, PID-14, PID-40"
},
{
"identity" : "rim",
"map" : "telecom"
},
{
"identity" : "cda",
"map" : ".telecom"
}]
},
{
"id" : "Patient.gender",
"path" : "Patient.gender",
"short" : "male | female | other | unknown",
"definition" : "Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.",
"comment" : "The gender might not match the biological sex as determined by genetics or the individual's preferred identification. Note that for both humans and particularly animals, there are other legitimate possibilities than male and female, though the vast majority of systems and contexts only support male and female. Systems providing decision support or enforcing business rules should ideally do this on the basis of Observations dealing with the specific sex or gender aspect of interest (anatomical, chromosomal, social, etc.) However, because these observations are infrequently recorded, defaulting to the administrative gender is common practice. Where such defaulting occurs, rule enforcement should allow for the variation between administrative and biological, chromosomal and other gender aspects. For example, an alert about a hysterectomy on a male should be handled as a warning or overridable error, not a \"hard\" error. See the Patient Gender and Sex section for additional information about communicating patient gender and sex.",
"requirements" : "Needed for identification of the individual, in combination with (at least) name and birth date.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Patient.gender",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AdministrativeGender"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "The gender of a person used for administrative purposes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1"
},
"mapping" : [{
"identity" : "v2",
"map" : "PID-8"
},
{
"identity" : "rim",
"map" : "player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender"
},
{
"identity" : "cda",
"map" : ".patient.administrativeGenderCode"
}]
},
{
"id" : "Patient.birthDate",
"path" : "Patient.birthDate",
"short" : "The date of birth for the individual",
"definition" : "The date of birth for the individual.",
"comment" : "At least an estimated year should be provided as a guess if the real DOB is unknown There is a standard extension \"patient-birthTime\" available that should be used where Time is required (such as in maternity/infant care systems).",
"requirements" : "Age of the individual drives many clinical processes.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Patient.birthDate",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "date"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "v2",
"map" : "PID-7"
},
{
"identity" : "rim",
"map" : "player[classCode=PSN|ANM and determinerCode=INSTANCE]/birthTime"
},
{
"identity" : "cda",
"map" : ".patient.birthTime"
},
{
"identity" : "loinc",
"map" : "21112-8"
}]
},
{
"id" : "Patient.deceased[x]",
"path" : "Patient.deceased[x]",
"short" : "Indicates if the individual is deceased or not",
"definition" : "Indicates if the individual is deceased or not.",
"comment" : "If there's no value in the instance, it means there is no statement on whether or not the individual is deceased. Most systems will interpret the absence of a value as a sign of the person being alive.",
"requirements" : "The fact that a patient is deceased influences the clinical process. Also, in human communication and relation management it is necessary to know whether the person is alive.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Patient.deceased[x]",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
},
{
"code" : "dateTime"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because once a patient is marked as deceased, the actions that are appropriate to perform on the patient may be significantly different.",
"isSummary" : true,
"mapping" : [{
"identity" : "v2",
"map" : "PID-30 (bool) and PID-29 (datetime)"
},
{
"identity" : "rim",
"map" : "player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedInd, player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedTime"
},
{
"identity" : "cda",
"map" : "n/a"
}]
},
{
"id" : "Patient.address",
"path" : "Patient.address",
"short" : "An address for the individual",
"definition" : "An address for the individual.",
"comment" : "Patient may have multiple addresses with different uses or applicable periods.",
"requirements" : "May need to keep track of patient addresses for contacting, billing or reporting requirements and also to help with identification.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Patient.address",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Address"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "v2",
"map" : "PID-11"
},
{
"identity" : "rim",
"map" : "addr"
},
{
"identity" : "cda",
"map" : ".addr"
}]
},
{
"id" : "Patient.maritalStatus",
"path" : "Patient.maritalStatus",
"short" : "Marital (civil) status of a patient",
"definition" : "This field contains a patient's most recent marital (civil) status.",
"requirements" : "Most, if not all systems capture it.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Patient.maritalStatus",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MaritalStatus"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "extensible",
"description" : "The domestic partnership status of a person.",
"valueSet" : "http://hl7.org/fhir/ValueSet/marital-status"
},
"mapping" : [{
"identity" : "v2",
"map" : "PID-16"
},
{
"identity" : "rim",
"map" : "player[classCode=PSN]/maritalStatusCode"
},
{
"identity" : "cda",
"map" : ".patient.maritalStatusCode"
}]
},
{
"id" : "Patient.multipleBirth[x]",
"path" : "Patient.multipleBirth[x]",
"short" : "Whether patient is part of a multiple birth",
"definition" : "Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer).",
"comment" : "Where the valueInteger is provided, the number is the birth number in the sequence. E.g. The middle birth in triplets would be valueInteger=2 and the third born would have valueInteger=3 If a boolean value was provided for this triplets example, then all 3 patient records would have valueBoolean=true (the ordering is not indicated).",
"requirements" : "For disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Patient.multipleBirth[x]",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
},
{
"code" : "integer"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "PID-24 (bool), PID-25 (integer)"
},
{
"identity" : "rim",
"map" : "player[classCode=PSN|ANM and determinerCode=INSTANCE]/multipleBirthInd, player[classCode=PSN|ANM and determinerCode=INSTANCE]/multipleBirthOrderNumber"
},
{
"identity" : "cda",
"map" : "n/a"
}]
},
{
"id" : "Patient.photo",
"path" : "Patient.photo",
"short" : "Image of the patient",
"definition" : "Image of the patient.",
"comment" : "Guidelines:\n* Use id photos, not clinical photos.\n* Limit dimensions to thumbnail.\n* Keep byte count low to ease resource updates.",
"requirements" : "Many EHR systems have the capability to capture an image of the patient. Fits with newer social media usage too.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Patient.photo",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Attachment"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "OBX-5 - needs a profile"
},
{
"identity" : "rim",
"map" : "player[classCode=PSN|ANM and determinerCode=INSTANCE]/desc"
},
{
"identity" : "cda",
"map" : "n/a"
}]
},
{
"id" : "Patient.contact",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "Contact"
}],
"path" : "Patient.contact",
"short" : "A contact party (e.g. guardian, partner, friend) for the patient",
"definition" : "A contact party (e.g. guardian, partner, friend) for the patient.",
"comment" : "Contact covers all kinds of contact parties: family members, business contacts, guardians, caregivers. Not applicable to register pedigree and family ties beyond use of having contact.",
"requirements" : "Need to track people you can contact about the patient.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Patient.contact",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "pat-1",
"severity" : "error",
"human" : "SHALL at least contain a contact's details or a reference to an organization",
"expression" : "name.exists() or telecom.exists() or address.exists() or organization.exists()",
"xpath" : "exists(f:name) or exists(f:telecom) or exists(f:address) or exists(f:organization)"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "player[classCode=PSN|ANM and determinerCode=INSTANCE]/scopedRole[classCode=CON]"
},
{
"identity" : "cda",
"map" : "n/a"
}]
},
{
"id" : "Patient.contact.id",
"path" : "Patient.contact.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Patient.contact.extension",
"path" : "Patient.contact.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Patient.contact.modifierExtension",
"path" : "Patient.contact.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Patient.contact.relationship",
"path" : "Patient.contact.relationship",
"short" : "The kind of relationship",
"definition" : "The nature of the relationship between the patient and the contact person.",
"requirements" : "Used to determine which contact person is the most relevant to approach, depending on circumstances.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Patient.contact.relationship",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ContactRelationship"
}],
"strength" : "extensible",
"description" : "The nature of the relationship between a patient and a contact person for that patient.",
"valueSet" : "http://hl7.org/fhir/ValueSet/patient-contactrelationship"
},
"mapping" : [{
"identity" : "v2",
"map" : "NK1-7, NK1-3"
},
{
"identity" : "rim",
"map" : "code"
},
{
"identity" : "cda",
"map" : "n/a"
}]
},
{
"id" : "Patient.contact.name",
"path" : "Patient.contact.name",
"short" : "A name associated with the contact person",
"definition" : "A name associated with the contact person.",
"requirements" : "Contact persons need to be identified by name, but it is uncommon to need details about multiple other names for that contact person.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Patient.contact.name",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "HumanName"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "NK1-2"
},
{
"identity" : "rim",
"map" : "name"
},
{
"identity" : "cda",
"map" : "n/a"
}]
},
{
"id" : "Patient.contact.telecom",
"path" : "Patient.contact.telecom",
"short" : "A contact detail for the person",
"definition" : "A contact detail for the person, e.g. a telephone number or an email address.",
"comment" : "Contact may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently, and also to help with identification.",
"requirements" : "People have (primary) ways to contact them in some way such as phone, email.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Patient.contact.telecom",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "ContactPoint"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "NK1-5, NK1-6, NK1-40"
},
{
"identity" : "rim",
"map" : "telecom"
},
{
"identity" : "cda",
"map" : "n/a"
}]
},
{
"id" : "Patient.contact.address",
"path" : "Patient.contact.address",
"short" : "Address for the contact person",
"definition" : "Address for the contact person.",
"requirements" : "Need to keep track where the contact person can be contacted per postal mail or visited.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Patient.contact.address",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Address"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "NK1-4"
},
{
"identity" : "rim",
"map" : "addr"
},
{
"identity" : "cda",
"map" : "n/a"
}]
},
{
"id" : "Patient.contact.gender",
"path" : "Patient.contact.gender",
"short" : "male | female | other | unknown",
"definition" : "Administrative Gender - the gender that the contact person is considered to have for administration and record keeping purposes.",
"requirements" : "Needed to address the person correctly.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Patient.contact.gender",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AdministrativeGender"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "The gender of a person used for administrative purposes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1"
},
"mapping" : [{
"identity" : "v2",
"map" : "NK1-15"
},
{
"identity" : "rim",
"map" : "player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender"
},
{
"identity" : "cda",
"map" : "n/a"
}]
},
{
"id" : "Patient.contact.organization",
"path" : "Patient.contact.organization",
"short" : "Organization that is associated with the contact",
"definition" : "Organization on behalf of which the contact is acting or for which the contact is working.",
"requirements" : "For guardians or business related contacts, the organization is relevant.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Patient.contact.organization",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"condition" : ["pat-1"],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "NK1-13, NK1-30, NK1-31, NK1-32, NK1-41"
},
{
"identity" : "rim",
"map" : "scoper"
},
{
"identity" : "cda",
"map" : "n/a"
}]
},
{
"id" : "Patient.contact.period",
"path" : "Patient.contact.period",
"short" : "The period during which this contact person or organization is valid to be contacted relating to this patient",
"definition" : "The period during which this contact person or organization is valid to be contacted relating to this patient.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Patient.contact.period",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Period"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "effectiveTime"
},
{
"identity" : "cda",
"map" : "n/a"
}]
},
{
"id" : "Patient.communication",
"path" : "Patient.communication",
"short" : "A language which may be used to communicate with the patient about his or her health",
"definition" : "A language which may be used to communicate with the patient about his or her health.",
"comment" : "If no language is specified, this *implies* that the default local language is spoken. If you need to convey proficiency for multiple modes, then you need multiple Patient.Communication associations. For animals, language is not a relevant field, and should be absent from the instance. If the Patient does not speak the default local language, then the Interpreter Required Standard can be used to explicitly declare that an interpreter is required.",
"requirements" : "If a patient does not speak the local language, interpreters may be required, so languages spoken and proficiency are important things to keep track of both for patient and other persons of interest.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Patient.communication",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "LanguageCommunication"
},
{
"identity" : "cda",
"map" : "patient.languageCommunication"
}]
},
{
"id" : "Patient.communication.id",
"path" : "Patient.communication.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Patient.communication.extension",
"path" : "Patient.communication.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Patient.communication.modifierExtension",
"path" : "Patient.communication.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Patient.communication.language",
"path" : "Patient.communication.language",
"short" : "The language which can be used to communicate with the patient about his or her health",
"definition" : "The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. \"en\" for English, or \"en-US\" for American English versus \"en-EN\" for England English.",
"comment" : "The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems actually code this but instead have it as free text. Hence CodeableConcept instead of code as the data type.",
"requirements" : "Most systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Patient.communication.language",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
},
"mapping" : [{
"identity" : "v2",
"map" : "PID-15, LAN-2"
},
{
"identity" : "rim",
"map" : "player[classCode=PSN|ANM and determinerCode=INSTANCE]/languageCommunication/code"
},
{
"identity" : "cda",
"map" : ".languageCode"
}]
},
{
"id" : "Patient.communication.preferred",
"path" : "Patient.communication.preferred",
"short" : "Language preference indicator",
"definition" : "Indicates whether or not the patient prefers this language (over other languages he masters up a certain level).",
"comment" : "This language is specifically identified for communicating healthcare information.",
"requirements" : "People that master multiple languages up to certain level may prefer one or more, i.e. feel more confident in communicating in a particular language making other languages sort of a fall back method.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Patient.communication.preferred",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "PID-15"
},
{
"identity" : "rim",
"map" : "preferenceInd"
},
{
"identity" : "cda",
"map" : ".preferenceInd"
}]
},
{
"id" : "Patient.generalPractitioner",
"path" : "Patient.generalPractitioner",
"short" : "Patient's nominated primary care provider",
"definition" : "Patient's nominated care provider.",
"comment" : "This may be the primary care provider (in a GP context), or it may be a patient nominated care manager in a community/disability setting, or even organization that will provide people to perform the care provider roles. It is not to be used to record Care Teams, these should be in a CareTeam resource that may be linked to the CarePlan or EpisodeOfCare resources.\nMultiple GPs may be recorded against the patient for various reasons, such as a student that has his home GP listed along with the GP at university during the school semesters, or a \"fly-in/fly-out\" worker that has the onsite GP also included with his home GP to remain aware of medical issues.\n\nJurisdictions may decide that they can profile this down to 1 if desired, or 1 per type.",
"alias" : ["careProvider"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Patient.generalPractitioner",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization",
"http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "PD1-4"
},
{
"identity" : "rim",
"map" : "subjectOf.CareEvent.performer.AssignedEntity"
},
{
"identity" : "cda",
"map" : "n/a"
}]
},
{
"id" : "Patient.managingOrganization",
"path" : "Patient.managingOrganization",
"short" : "Organization that is the custodian of the patient record",
"definition" : "Organization that is the custodian of the patient record.",
"comment" : "There is only one managing organization for a specific patient record. Other organizations will have their own Patient record, and may use the Link property to join the records together (or a Person resource which can include confidence ratings for the association).",
"requirements" : "Need to know who recognizes this patient record, manages and updates it.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Patient.managingOrganization",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "scoper"
},
{
"identity" : "cda",
"map" : ".providerOrganization"
}]
},
{
"id" : "Patient.link",
"path" : "Patient.link",
"short" : "Link to another patient resource that concerns the same actual person",
"definition" : "Link to another patient resource that concerns the same actual patient.",
"comment" : "There is no assumption that linked patient records have mutual links.",
"requirements" : "There are multiple use cases: \n\n* Duplicate patient records due to the clerical errors associated with the difficulties of identifying humans consistently, and \n* Distribution of patient information across multiple servers.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Patient.link",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because it might not be the main Patient resource, and the referenced patient should be used instead of this Patient record. This is when the link.type value is 'replaced-by'",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "outboundLink"
},
{
"identity" : "cda",
"map" : "n/a"
}]
},
{
"id" : "Patient.link.id",
"path" : "Patient.link.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Patient.link.extension",
"path" : "Patient.link.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Patient.link.modifierExtension",
"path" : "Patient.link.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Patient.link.other",
"path" : "Patient.link.other",
"short" : "The other patient or related person resource that the link refers to",
"definition" : "The other patient resource that the link refers to.",
"comment" : "Referencing a RelatedPerson here removes the need to use a Person record to associate a Patient and RelatedPerson as the same individual.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Patient.link.other",
"min" : 1,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-hierarchy",
"valueBoolean" : false
}],
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "v2",
"map" : "PID-3, MRG-1"
},
{
"identity" : "rim",
"map" : "id"
},
{
"identity" : "cda",
"map" : "n/a"
}]
},
{
"id" : "Patient.link.type",
"path" : "Patient.link.type",
"short" : "replaced-by | replaces | refer | seealso",
"definition" : "The type of link between this patient resource and another patient resource.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Patient.link.type",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "LinkType"
}],
"strength" : "required",
"description" : "The type of link between this patient resource and another patient resource.",
"valueSet" : "http://hl7.org/fhir/ValueSet/link-type|4.0.1"
},
"mapping" : [{
"identity" : "rim",
"map" : "typeCode"
},
{
"identity" : "cda",
"map" : "n/a"
}]
}]
},
"differential" : {
"element" : [{
"id" : "Patient",
"path" : "Patient",
"short" : "Information about an individual or animal receiving health care services",
"definition" : "Demographics and other administrative information about an individual or animal receiving care or other health-related services.",
"alias" : ["SubjectOfCare Client Resident"],
"min" : 0,
"max" : "*",
"mapping" : [{
"identity" : "rim",
"map" : "Patient[classCode=PAT]"
},
{
"identity" : "cda",
"map" : "ClinicalDocument.recordTarget.patientRole"
}]
},
{
"id" : "Patient.identifier",
"path" : "Patient.identifier",
"short" : "An identifier for this patient",
"definition" : "An identifier for this patient.",
"requirements" : "Patients are almost always assigned specific numerical identifiers.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Identifier"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "v2",
"map" : "PID-3"
},
{
"identity" : "rim",
"map" : "id"
},
{
"identity" : "cda",
"map" : ".id"
}]
},
{
"id" : "Patient.active",
"path" : "Patient.active",
"short" : "Whether this patient's record is in active use",
"definition" : "Whether this patient record is in active use. \nMany systems use this property to mark as non-current patients, such as those that have not been seen for a period of time based on an organization's business rules.\n\nIt is often used to filter patient lists to exclude inactive patients\n\nDeceased patients may also be marked as inactive for the same reasons, but may be active for some time after death.",
"comment" : "If a record is inactive, and linked to an active record, then future patient/record updates should occur on the other patient.",
"requirements" : "Need to be able to mark a patient record as not to be used because it was created in error.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "boolean"
}],
"meaningWhenMissing" : "This resource is generally assumed to be active if no value is provided for the active element",
"isModifier" : true,
"isModifierReason" : "This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid",
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.status"
},
{
"identity" : "rim",
"map" : "statusCode"
},
{
"identity" : "cda",
"map" : "n/a"
}]
},
{
"id" : "Patient.name",
"path" : "Patient.name",
"short" : "A name associated with the patient",
"definition" : "A name associated with the individual.",
"comment" : "A patient may have multiple names with different uses or applicable periods. For animals, the name is a \"HumanName\" in the sense that is assigned and used by humans and has the same patterns.",
"requirements" : "Need to be able to track the patient by multiple names. Examples are your official name and a partner name.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "HumanName"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "v2",
"map" : "PID-5, PID-9"
},
{
"identity" : "rim",
"map" : "name"
},
{
"identity" : "cda",
"map" : ".patient.name"
}]
},
{
"id" : "Patient.telecom",
"path" : "Patient.telecom",
"short" : "A contact detail for the individual",
"definition" : "A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.",
"comment" : "A Patient may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and also to help with identification. The address might not go directly to the individual, but may reach another party that is able to proxy for the patient (i.e. home phone, or pet owner's phone).",
"requirements" : "People have (primary) ways to contact them in some way such as phone, email.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "ContactPoint"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "v2",
"map" : "PID-13, PID-14, PID-40"
},
{
"identity" : "rim",
"map" : "telecom"
},
{
"identity" : "cda",
"map" : ".telecom"
}]
},
{
"id" : "Patient.gender",
"path" : "Patient.gender",
"short" : "male | female | other | unknown",
"definition" : "Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.",
"comment" : "The gender might not match the biological sex as determined by genetics or the individual's preferred identification. Note that for both humans and particularly animals, there are other legitimate possibilities than male and female, though the vast majority of systems and contexts only support male and female. Systems providing decision support or enforcing business rules should ideally do this on the basis of Observations dealing with the specific sex or gender aspect of interest (anatomical, chromosomal, social, etc.) However, because these observations are infrequently recorded, defaulting to the administrative gender is common practice. Where such defaulting occurs, rule enforcement should allow for the variation between administrative and biological, chromosomal and other gender aspects. For example, an alert about a hysterectomy on a male should be handled as a warning or overridable error, not a \"hard\" error. See the Patient Gender and Sex section for additional information about communicating patient gender and sex.",
"requirements" : "Needed for identification of the individual, in combination with (at least) name and birth date.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AdministrativeGender"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "The gender of a person used for administrative purposes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1"
},
"mapping" : [{
"identity" : "v2",
"map" : "PID-8"
},
{
"identity" : "rim",
"map" : "player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender"
},
{
"identity" : "cda",
"map" : ".patient.administrativeGenderCode"
}]
},
{
"id" : "Patient.birthDate",
"path" : "Patient.birthDate",
"short" : "The date of birth for the individual",
"definition" : "The date of birth for the individual.",
"comment" : "At least an estimated year should be provided as a guess if the real DOB is unknown There is a standard extension \"patient-birthTime\" available that should be used where Time is required (such as in maternity/infant care systems).",
"requirements" : "Age of the individual drives many clinical processes.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "date"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "v2",
"map" : "PID-7"
},
{
"identity" : "rim",
"map" : "player[classCode=PSN|ANM and determinerCode=INSTANCE]/birthTime"
},
{
"identity" : "cda",
"map" : ".patient.birthTime"
},
{
"identity" : "loinc",
"map" : "21112-8"
}]
},
{
"id" : "Patient.deceased[x]",
"path" : "Patient.deceased[x]",
"short" : "Indicates if the individual is deceased or not",
"definition" : "Indicates if the individual is deceased or not.",
"comment" : "If there's no value in the instance, it means there is no statement on whether or not the individual is deceased. Most systems will interpret the absence of a value as a sign of the person being alive.",
"requirements" : "The fact that a patient is deceased influences the clinical process. Also, in human communication and relation management it is necessary to know whether the person is alive.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "boolean"
},
{
"code" : "dateTime"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because once a patient is marked as deceased, the actions that are appropriate to perform on the patient may be significantly different.",
"isSummary" : true,
"mapping" : [{
"identity" : "v2",
"map" : "PID-30 (bool) and PID-29 (datetime)"
},
{
"identity" : "rim",
"map" : "player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedInd, player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedTime"
},
{
"identity" : "cda",
"map" : "n/a"
}]
},
{
"id" : "Patient.address",
"path" : "Patient.address",
"short" : "An address for the individual",
"definition" : "An address for the individual.",
"comment" : "Patient may have multiple addresses with different uses or applicable periods.",
"requirements" : "May need to keep track of patient addresses for contacting, billing or reporting requirements and also to help with identification.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Address"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "v2",
"map" : "PID-11"
},
{
"identity" : "rim",
"map" : "addr"
},
{
"identity" : "cda",
"map" : ".addr"
}]
},
{
"id" : "Patient.maritalStatus",
"path" : "Patient.maritalStatus",
"short" : "Marital (civil) status of a patient",
"definition" : "This field contains a patient's most recent marital (civil) status.",
"requirements" : "Most, if not all systems capture it.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MaritalStatus"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "extensible",
"description" : "The domestic partnership status of a person.",
"valueSet" : "http://hl7.org/fhir/ValueSet/marital-status"
},
"mapping" : [{
"identity" : "v2",
"map" : "PID-16"
},
{
"identity" : "rim",
"map" : "player[classCode=PSN]/maritalStatusCode"
},
{
"identity" : "cda",
"map" : ".patient.maritalStatusCode"
}]
},
{
"id" : "Patient.multipleBirth[x]",
"path" : "Patient.multipleBirth[x]",
"short" : "Whether patient is part of a multiple birth",
"definition" : "Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer).",
"comment" : "Where the valueInteger is provided, the number is the birth number in the sequence. E.g. The middle birth in triplets would be valueInteger=2 and the third born would have valueInteger=3 If a boolean value was provided for this triplets example, then all 3 patient records would have valueBoolean=true (the ordering is not indicated).",
"requirements" : "For disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "boolean"
},
{
"code" : "integer"
}],
"mapping" : [{
"identity" : "v2",
"map" : "PID-24 (bool), PID-25 (integer)"
},
{
"identity" : "rim",
"map" : "player[classCode=PSN|ANM and determinerCode=INSTANCE]/multipleBirthInd, player[classCode=PSN|ANM and determinerCode=INSTANCE]/multipleBirthOrderNumber"
},
{
"identity" : "cda",
"map" : "n/a"
}]
},
{
"id" : "Patient.photo",
"path" : "Patient.photo",
"short" : "Image of the patient",
"definition" : "Image of the patient.",
"comment" : "Guidelines:\n* Use id photos, not clinical photos.\n* Limit dimensions to thumbnail.\n* Keep byte count low to ease resource updates.",
"requirements" : "Many EHR systems have the capability to capture an image of the patient. Fits with newer social media usage too.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Attachment"
}],
"mapping" : [{
"identity" : "v2",
"map" : "OBX-5 - needs a profile"
},
{
"identity" : "rim",
"map" : "player[classCode=PSN|ANM and determinerCode=INSTANCE]/desc"
},
{
"identity" : "cda",
"map" : "n/a"
}]
},
{
"id" : "Patient.contact",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "Contact"
}],
"path" : "Patient.contact",
"short" : "A contact party (e.g. guardian, partner, friend) for the patient",
"definition" : "A contact party (e.g. guardian, partner, friend) for the patient.",
"comment" : "Contact covers all kinds of contact parties: family members, business contacts, guardians, caregivers. Not applicable to register pedigree and family ties beyond use of having contact.",
"requirements" : "Need to track people you can contact about the patient.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "pat-1",
"severity" : "error",
"human" : "SHALL at least contain a contact's details or a reference to an organization",
"expression" : "name.exists() or telecom.exists() or address.exists() or organization.exists()",
"xpath" : "exists(f:name) or exists(f:telecom) or exists(f:address) or exists(f:organization)"
}],
"mapping" : [{
"identity" : "rim",
"map" : "player[classCode=PSN|ANM and determinerCode=INSTANCE]/scopedRole[classCode=CON]"
},
{
"identity" : "cda",
"map" : "n/a"
}]
},
{
"id" : "Patient.contact.relationship",
"path" : "Patient.contact.relationship",
"short" : "The kind of relationship",
"definition" : "The nature of the relationship between the patient and the contact person.",
"requirements" : "Used to determine which contact person is the most relevant to approach, depending on circumstances.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ContactRelationship"
}],
"strength" : "extensible",
"description" : "The nature of the relationship between a patient and a contact person for that patient.",
"valueSet" : "http://hl7.org/fhir/ValueSet/patient-contactrelationship"
},
"mapping" : [{
"identity" : "v2",
"map" : "NK1-7, NK1-3"
},
{
"identity" : "rim",
"map" : "code"
},
{
"identity" : "cda",
"map" : "n/a"
}]
},
{
"id" : "Patient.contact.name",
"path" : "Patient.contact.name",
"short" : "A name associated with the contact person",
"definition" : "A name associated with the contact person.",
"requirements" : "Contact persons need to be identified by name, but it is uncommon to need details about multiple other names for that contact person.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "HumanName"
}],
"mapping" : [{
"identity" : "v2",
"map" : "NK1-2"
},
{
"identity" : "rim",
"map" : "name"
},
{
"identity" : "cda",
"map" : "n/a"
}]
},
{
"id" : "Patient.contact.telecom",
"path" : "Patient.contact.telecom",
"short" : "A contact detail for the person",
"definition" : "A contact detail for the person, e.g. a telephone number or an email address.",
"comment" : "Contact may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently, and also to help with identification.",
"requirements" : "People have (primary) ways to contact them in some way such as phone, email.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "ContactPoint"
}],
"mapping" : [{
"identity" : "v2",
"map" : "NK1-5, NK1-6, NK1-40"
},
{
"identity" : "rim",
"map" : "telecom"
},
{
"identity" : "cda",
"map" : "n/a"
}]
},
{
"id" : "Patient.contact.address",
"path" : "Patient.contact.address",
"short" : "Address for the contact person",
"definition" : "Address for the contact person.",
"requirements" : "Need to keep track where the contact person can be contacted per postal mail or visited.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Address"
}],
"mapping" : [{
"identity" : "v2",
"map" : "NK1-4"
},
{
"identity" : "rim",
"map" : "addr"
},
{
"identity" : "cda",
"map" : "n/a"
}]
},
{
"id" : "Patient.contact.gender",
"path" : "Patient.contact.gender",
"short" : "male | female | other | unknown",
"definition" : "Administrative Gender - the gender that the contact person is considered to have for administration and record keeping purposes.",
"requirements" : "Needed to address the person correctly.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "code"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AdministrativeGender"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "The gender of a person used for administrative purposes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1"
},
"mapping" : [{
"identity" : "v2",
"map" : "NK1-15"
},
{
"identity" : "rim",
"map" : "player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender"
},
{
"identity" : "cda",
"map" : "n/a"
}]
},
{
"id" : "Patient.contact.organization",
"path" : "Patient.contact.organization",
"short" : "Organization that is associated with the contact",
"definition" : "Organization on behalf of which the contact is acting or for which the contact is working.",
"requirements" : "For guardians or business related contacts, the organization is relevant.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"condition" : ["pat-1"],
"mapping" : [{
"identity" : "v2",
"map" : "NK1-13, NK1-30, NK1-31, NK1-32, NK1-41"
},
{
"identity" : "rim",
"map" : "scoper"
},
{
"identity" : "cda",
"map" : "n/a"
}]
},
{
"id" : "Patient.contact.period",
"path" : "Patient.contact.period",
"short" : "The period during which this contact person or organization is valid to be contacted relating to this patient",
"definition" : "The period during which this contact person or organization is valid to be contacted relating to this patient.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Period"
}],
"mapping" : [{
"identity" : "rim",
"map" : "effectiveTime"
},
{
"identity" : "cda",
"map" : "n/a"
}]
},
{
"id" : "Patient.communication",
"path" : "Patient.communication",
"short" : "A language which may be used to communicate with the patient about his or her health",
"definition" : "A language which may be used to communicate with the patient about his or her health.",
"comment" : "If no language is specified, this *implies* that the default local language is spoken. If you need to convey proficiency for multiple modes, then you need multiple Patient.Communication associations. For animals, language is not a relevant field, and should be absent from the instance. If the Patient does not speak the default local language, then the Interpreter Required Standard can be used to explicitly declare that an interpreter is required.",
"requirements" : "If a patient does not speak the local language, interpreters may be required, so languages spoken and proficiency are important things to keep track of both for patient and other persons of interest.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"mapping" : [{
"identity" : "rim",
"map" : "LanguageCommunication"
},
{
"identity" : "cda",
"map" : "patient.languageCommunication"
}]
},
{
"id" : "Patient.communication.language",
"path" : "Patient.communication.language",
"short" : "The language which can be used to communicate with the patient about his or her health",
"definition" : "The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. \"en\" for English, or \"en-US\" for American English versus \"en-EN\" for England English.",
"comment" : "The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems actually code this but instead have it as free text. Hence CodeableConcept instead of code as the data type.",
"requirements" : "Most systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
},
"mapping" : [{
"identity" : "v2",
"map" : "PID-15, LAN-2"
},
{
"identity" : "rim",
"map" : "player[classCode=PSN|ANM and determinerCode=INSTANCE]/languageCommunication/code"
},
{
"identity" : "cda",
"map" : ".languageCode"
}]
},
{
"id" : "Patient.communication.preferred",
"path" : "Patient.communication.preferred",
"short" : "Language preference indicator",
"definition" : "Indicates whether or not the patient prefers this language (over other languages he masters up a certain level).",
"comment" : "This language is specifically identified for communicating healthcare information.",
"requirements" : "People that master multiple languages up to certain level may prefer one or more, i.e. feel more confident in communicating in a particular language making other languages sort of a fall back method.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "boolean"
}],
"mapping" : [{
"identity" : "v2",
"map" : "PID-15"
},
{
"identity" : "rim",
"map" : "preferenceInd"
},
{
"identity" : "cda",
"map" : ".preferenceInd"
}]
},
{
"id" : "Patient.generalPractitioner",
"path" : "Patient.generalPractitioner",
"short" : "Patient's nominated primary care provider",
"definition" : "Patient's nominated care provider.",
"comment" : "This may be the primary care provider (in a GP context), or it may be a patient nominated care manager in a community/disability setting, or even organization that will provide people to perform the care provider roles. It is not to be used to record Care Teams, these should be in a CareTeam resource that may be linked to the CarePlan or EpisodeOfCare resources.\nMultiple GPs may be recorded against the patient for various reasons, such as a student that has his home GP listed along with the GP at university during the school semesters, or a \"fly-in/fly-out\" worker that has the onsite GP also included with his home GP to remain aware of medical issues.\n\nJurisdictions may decide that they can profile this down to 1 if desired, or 1 per type.",
"alias" : ["careProvider"],
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization",
"http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole"]
}],
"mapping" : [{
"identity" : "v2",
"map" : "PD1-4"
},
{
"identity" : "rim",
"map" : "subjectOf.CareEvent.performer.AssignedEntity"
},
{
"identity" : "cda",
"map" : "n/a"
}]
},
{
"id" : "Patient.managingOrganization",
"path" : "Patient.managingOrganization",
"short" : "Organization that is the custodian of the patient record",
"definition" : "Organization that is the custodian of the patient record.",
"comment" : "There is only one managing organization for a specific patient record. Other organizations will have their own Patient record, and may use the Link property to join the records together (or a Person resource which can include confidence ratings for the association).",
"requirements" : "Need to know who recognizes this patient record, manages and updates it.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "scoper"
},
{
"identity" : "cda",
"map" : ".providerOrganization"
}]
},
{
"id" : "Patient.link",
"path" : "Patient.link",
"short" : "Link to another patient resource that concerns the same actual person",
"definition" : "Link to another patient resource that concerns the same actual patient.",
"comment" : "There is no assumption that linked patient records have mutual links.",
"requirements" : "There are multiple use cases: \n\n* Duplicate patient records due to the clerical errors associated with the difficulties of identifying humans consistently, and \n* Distribution of patient information across multiple servers.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because it might not be the main Patient resource, and the referenced patient should be used instead of this Patient record. This is when the link.type value is 'replaced-by'",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "outboundLink"
},
{
"identity" : "cda",
"map" : "n/a"
}]
},
{
"id" : "Patient.link.other",
"path" : "Patient.link.other",
"short" : "The other patient or related person resource that the link refers to",
"definition" : "The other patient resource that the link refers to.",
"comment" : "Referencing a RelatedPerson here removes the need to use a Person record to associate a Patient and RelatedPerson as the same individual.",
"min" : 1,
"max" : "1",
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-hierarchy",
"valueBoolean" : false
}],
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "v2",
"map" : "PID-3, MRG-1"
},
{
"identity" : "rim",
"map" : "id"
},
{
"identity" : "cda",
"map" : "n/a"
}]
},
{
"id" : "Patient.link.type",
"path" : "Patient.link.type",
"short" : "replaced-by | replaces | refer | seealso",
"definition" : "The type of link between this patient resource and another patient resource.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "LinkType"
}],
"strength" : "required",
"description" : "The type of link between this patient resource and another patient resource.",
"valueSet" : "http://hl7.org/fhir/ValueSet/link-type|4.0.1"
},
"mapping" : [{
"identity" : "rim",
"map" : "typeCode"
},
{
"identity" : "cda",
"map" : "n/a"
}]
}]
}
}
},
{
"fullUrl" : "http://hl7.org/fhir/StructureDefinition/PaymentNotice",
"resource" : {
"resourceType" : "StructureDefinition",
"id" : "PaymentNotice",
"meta" : {
"lastUpdated" : "2019-11-01T09:29:23.356+11:00"
},
"text" : {
"status" : "generated",
"div" : "Name Flags Card. Type Description & Constraints PaymentNotice TU DomainResource PaymentNotice request
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension identifier 0..* Identifier Business Identifier for the payment noctice
status ?!Σ 1..1 code active | cancelled | draft | entered-in-error
Financial Resource Status Codes (Required) request 0..1 Reference(Any) Request reference response 0..1 Reference(Any) Response reference created Σ 1..1 dateTime Creation date provider 0..1 Reference(Practitioner | PractitionerRole | Organization) Responsible practitioner payment Σ 1..1 Reference(PaymentReconciliation) Payment reference paymentDate 0..1 date Payment or clearing date payee 0..1 Reference(Practitioner | PractitionerRole | Organization) Party being paid recipient Σ 1..1 Reference(Organization) Party being notified amount Σ 1..1 Money Monetary amount of the payment paymentStatus 0..1 CodeableConcept Issued or cleared Status of the payment
Payment Status Codes (Example)
Documentation for this format
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Financial.Payment"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 2
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "patient"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "fm"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/PaymentNotice",
"version" : "4.0.1",
"name" : "PaymentNotice",
"status" : "draft",
"date" : "2019-11-01T09:29:23+11:00",
"publisher" : "Health Level Seven International (Financial Management)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/fm/index.cfm"
}]
}],
"description" : "This resource provides the status of the payment for goods and services rendered, and the request and response resource references.",
"fhirVersion" : "4.0.1",
"mapping" : [{
"identity" : "workflow",
"uri" : "http://hl7.org/fhir/workflow",
"name" : "Workflow Pattern"
},
{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/fivews",
"name" : "FiveWs Pattern Mapping"
},
{
"identity" : "cdanetv4",
"uri" : "http://www.cda-adc.ca/en/services/cdanet/",
"name" : "Canadian Dental Association eclaims standard"
},
{
"identity" : "v2",
"uri" : "http://hl7.org/v2",
"name" : "HL7 v2 Mapping"
}],
"kind" : "resource",
"abstract" : false,
"type" : "PaymentNotice",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "PaymentNotice",
"path" : "PaymentNotice",
"short" : "PaymentNotice request",
"definition" : "This resource provides the status of the payment for goods and services rendered, and the request and response resource references.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "PaymentNotice",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "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",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.`div`.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "workflow",
"map" : "Event"
},
{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "PaymentNotice.id",
"path" : "PaymentNotice.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "PaymentNotice.meta",
"path" : "PaymentNotice.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "PaymentNotice.implicitRules",
"path" : "PaymentNotice.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "PaymentNotice.language",
"path" : "PaymentNotice.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "PaymentNotice.text",
"path" : "PaymentNotice.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "PaymentNotice.contained",
"path" : "PaymentNotice.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "PaymentNotice.extension",
"path" : "PaymentNotice.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "PaymentNotice.modifierExtension",
"path" : "PaymentNotice.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "PaymentNotice.identifier",
"path" : "PaymentNotice.identifier",
"short" : "Business Identifier for the payment noctice",
"definition" : "A unique identifier assigned to this payment notice.",
"requirements" : "Allows payment notices to be distinguished and referenced.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "PaymentNotice.identifier",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Identifier"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.identifier"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "PaymentNotice.status",
"path" : "PaymentNotice.status",
"short" : "active | cancelled | draft | entered-in-error",
"definition" : "The status of the resource instance.",
"comment" : "This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.",
"requirements" : "Need to track the status of the resource as 'draft' resources may undergo further edits while 'active' resources are immutable and may only have their status changed to 'cancelled'.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "PaymentNotice.status",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "PaymentNoticeStatus"
}],
"strength" : "required",
"description" : "A code specifying the state of the resource instance.",
"valueSet" : "http://hl7.org/fhir/ValueSet/fm-status|4.0.1"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.status"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
},
{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "PaymentNotice.request",
"path" : "PaymentNotice.request",
"short" : "Request reference",
"definition" : "Reference of resource for which payment is being made.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "PaymentNotice.request",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.basedOn"
},
{
"identity" : "w5",
"map" : "FiveWs.subject[x]"
},
{
"identity" : "w5",
"map" : "FiveWs.subject"
}]
},
{
"id" : "PaymentNotice.response",
"path" : "PaymentNotice.response",
"short" : "Response reference",
"definition" : "Reference of response to resource for which payment is being made.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "PaymentNotice.response",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.subject[x]"
},
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "w5",
"map" : "FiveWs.subject"
}]
},
{
"id" : "PaymentNotice.created",
"path" : "PaymentNotice.created",
"short" : "Creation date",
"definition" : "The date when this resource was created.",
"requirements" : "Need to record a timestamp for use by both the recipient and the issuer.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "PaymentNotice.created",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.occurrence[x]"
},
{
"identity" : "w5",
"map" : "FiveWs.recorded"
},
{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "PaymentNotice.provider",
"path" : "PaymentNotice.provider",
"short" : "Responsible practitioner",
"definition" : "The practitioner who is responsible for the services rendered to the patient.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "PaymentNotice.provider",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.performer"
},
{
"identity" : "w5",
"map" : "FiveWs.source"
},
{
"identity" : "cdanetv4",
"map" : "B01"
},
{
"identity" : "v2",
"map" : "B01"
},
{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "PaymentNotice.payment",
"path" : "PaymentNotice.payment",
"short" : "Payment reference",
"definition" : "A reference to the payment which is the subject of this notice.",
"requirements" : "Need to identify the actual payment.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "PaymentNotice.payment",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/PaymentReconciliation"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "PaymentNotice.paymentDate",
"path" : "PaymentNotice.paymentDate",
"short" : "Payment or clearing date",
"definition" : "The date when the above payment action occurred.",
"requirements" : "Need to convey the date when the action being notified occurred.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "PaymentNotice.paymentDate",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "date"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "PaymentNotice.payee",
"path" : "PaymentNotice.payee",
"short" : "Party being paid",
"definition" : "The party who will receive or has received payment that is the subject of this notification.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "PaymentNotice.payee",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "PaymentNotice.recipient",
"path" : "PaymentNotice.recipient",
"short" : "Party being notified",
"definition" : "The party who is notified of the payment status.",
"requirements" : "Need to identified the recipient of the notification.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "PaymentNotice.recipient",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "PaymentNotice.amount",
"path" : "PaymentNotice.amount",
"short" : "Monetary amount of the payment",
"definition" : "The amount sent to the payee.",
"requirements" : "Provided for validation purposes.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "PaymentNotice.amount",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "Money"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "PaymentNotice.paymentStatus",
"path" : "PaymentNotice.paymentStatus",
"short" : "Issued or cleared Status of the payment",
"definition" : "A code indicating whether payment has been sent or cleared.",
"comment" : "Typically paid: payment sent, cleared: payment received.",
"requirements" : "The purpose of the notification.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "PaymentNotice.paymentStatus",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "PaymentStatus"
}],
"strength" : "example",
"description" : "The payment conveyance status codes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/payment-status"
},
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
}]
},
"differential" : {
"element" : [{
"id" : "PaymentNotice",
"path" : "PaymentNotice",
"short" : "PaymentNotice request",
"definition" : "This resource provides the status of the payment for goods and services rendered, and the request and response resource references.",
"min" : 0,
"max" : "*",
"mapping" : [{
"identity" : "workflow",
"map" : "Event"
},
{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "PaymentNotice.identifier",
"path" : "PaymentNotice.identifier",
"short" : "Business Identifier for the payment noctice",
"definition" : "A unique identifier assigned to this payment notice.",
"requirements" : "Allows payment notices to be distinguished and referenced.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Identifier"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Event.identifier"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "PaymentNotice.status",
"path" : "PaymentNotice.status",
"short" : "active | cancelled | draft | entered-in-error",
"definition" : "The status of the resource instance.",
"comment" : "This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.",
"requirements" : "Need to track the status of the resource as 'draft' resources may undergo further edits while 'active' resources are immutable and may only have their status changed to 'cancelled'.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isModifier" : true,
"isModifierReason" : "This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "PaymentNoticeStatus"
}],
"strength" : "required",
"description" : "A code specifying the state of the resource instance.",
"valueSet" : "http://hl7.org/fhir/ValueSet/fm-status|4.0.1"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.status"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
},
{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "PaymentNotice.request",
"path" : "PaymentNotice.request",
"short" : "Request reference",
"definition" : "Reference of resource for which payment is being made.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Event.basedOn"
},
{
"identity" : "w5",
"map" : "FiveWs.subject[x]"
},
{
"identity" : "w5",
"map" : "FiveWs.subject"
}]
},
{
"id" : "PaymentNotice.response",
"path" : "PaymentNotice.response",
"short" : "Response reference",
"definition" : "Reference of response to resource for which payment is being made.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.subject[x]"
},
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "w5",
"map" : "FiveWs.subject"
}]
},
{
"id" : "PaymentNotice.created",
"path" : "PaymentNotice.created",
"short" : "Creation date",
"definition" : "The date when this resource was created.",
"requirements" : "Need to record a timestamp for use by both the recipient and the issuer.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "dateTime"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.occurrence[x]"
},
{
"identity" : "w5",
"map" : "FiveWs.recorded"
},
{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "PaymentNotice.provider",
"path" : "PaymentNotice.provider",
"short" : "Responsible practitioner",
"definition" : "The practitioner who is responsible for the services rendered to the patient.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Event.performer"
},
{
"identity" : "w5",
"map" : "FiveWs.source"
},
{
"identity" : "cdanetv4",
"map" : "B01"
},
{
"identity" : "v2",
"map" : "B01"
},
{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "PaymentNotice.payment",
"path" : "PaymentNotice.payment",
"short" : "Payment reference",
"definition" : "A reference to the payment which is the subject of this notice.",
"requirements" : "Need to identify the actual payment.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/PaymentReconciliation"]
}],
"isSummary" : true
},
{
"id" : "PaymentNotice.paymentDate",
"path" : "PaymentNotice.paymentDate",
"short" : "Payment or clearing date",
"definition" : "The date when the above payment action occurred.",
"requirements" : "Need to convey the date when the action being notified occurred.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "date"
}]
},
{
"id" : "PaymentNotice.payee",
"path" : "PaymentNotice.payee",
"short" : "Party being paid",
"definition" : "The party who will receive or has received payment that is the subject of this notification.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Organization"]
}]
},
{
"id" : "PaymentNotice.recipient",
"path" : "PaymentNotice.recipient",
"short" : "Party being notified",
"definition" : "The party who is notified of the payment status.",
"requirements" : "Need to identified the recipient of the notification.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "PaymentNotice.amount",
"path" : "PaymentNotice.amount",
"short" : "Monetary amount of the payment",
"definition" : "The amount sent to the payee.",
"requirements" : "Provided for validation purposes.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "Money"
}],
"isSummary" : true
},
{
"id" : "PaymentNotice.paymentStatus",
"path" : "PaymentNotice.paymentStatus",
"short" : "Issued or cleared Status of the payment",
"definition" : "A code indicating whether payment has been sent or cleared.",
"comment" : "Typically paid: payment sent, cleared: payment received.",
"requirements" : "The purpose of the notification.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "PaymentStatus"
}],
"strength" : "example",
"description" : "The payment conveyance status codes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/payment-status"
},
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
}]
}
}
},
{
"fullUrl" : "http://hl7.org/fhir/StructureDefinition/PaymentReconciliation",
"resource" : {
"resourceType" : "StructureDefinition",
"id" : "PaymentReconciliation",
"meta" : {
"lastUpdated" : "2019-11-01T09:29:23.356+11:00"
},
"text" : {
"status" : "generated",
"div" : "Name Flags Card. Type Description & Constraints PaymentReconciliation TU DomainResource PaymentReconciliation resource
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension identifier 0..* Identifier Business Identifier for a payment reconciliation
status ?!Σ 1..1 code active | cancelled | draft | entered-in-error
Financial Resource Status Codes (Required) period Σ 0..1 Period Period covered created Σ 1..1 dateTime Creation date paymentIssuer Σ 0..1 Reference(Organization) Party generating payment request 0..1 Reference(Task) Reference to requesting resource requestor 0..1 Reference(Practitioner | PractitionerRole | Organization) Responsible practitioner outcome 0..1 code queued | complete | error | partial
RemittanceOutcome (Required) disposition 0..1 string Disposition message paymentDate Σ 1..1 date When payment issued paymentAmount Σ 1..1 Money Total amount of Payment paymentIdentifier 0..1 Identifier Business identifier for the payment detail 0..* BackboneElement Settlement particulars
identifier 0..1 Identifier Business identifier of the payment detail predecessor 0..1 Identifier Business identifier of the prior payment detail type 1..1 CodeableConcept Category of payment
Payment Type Codes (Example) request 0..1 Reference(Any) Request giving rise to the payment submitter 0..1 Reference(Practitioner | PractitionerRole | Organization) Submitter of the request response 0..1 Reference(Any) Response committing to a payment date 0..1 date Date of commitment to pay responsible 0..1 Reference(PractitionerRole) Contact for the response payee 0..1 Reference(Practitioner | PractitionerRole | Organization) Recipient of the payment amount 0..1 Money Amount allocated to this payable formCode 0..1 CodeableConcept Printed form identifier
Forms (Example) processNote 0..* BackboneElement Note concerning processing
type 0..1 code display | print | printoper
NoteType (Required) text 0..1 string Note explanatory text
Documentation for this format
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Financial.Payment"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 2
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "patient"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "fm"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/PaymentReconciliation",
"version" : "4.0.1",
"name" : "PaymentReconciliation",
"status" : "draft",
"date" : "2019-11-01T09:29:23+11:00",
"publisher" : "Health Level Seven International (Financial Management)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/fm/index.cfm"
}]
}],
"description" : "This resource provides the details including amount of a payment and allocates the payment items being paid.",
"fhirVersion" : "4.0.1",
"mapping" : [{
"identity" : "workflow",
"uri" : "http://hl7.org/fhir/workflow",
"name" : "Workflow Pattern"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/fivews",
"name" : "FiveWs Pattern Mapping"
},
{
"identity" : "cdanetv4",
"uri" : "http://www.cda-adc.ca/en/services/cdanet/",
"name" : "Canadian Dental Association eclaims standard"
},
{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
}],
"kind" : "resource",
"abstract" : false,
"type" : "PaymentReconciliation",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "PaymentReconciliation",
"path" : "PaymentReconciliation",
"short" : "PaymentReconciliation resource",
"definition" : "This resource provides the details including amount of a payment and allocates the payment items being paid.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "PaymentReconciliation",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "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",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.`div`.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "workflow",
"map" : "Event"
}]
},
{
"id" : "PaymentReconciliation.id",
"path" : "PaymentReconciliation.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "PaymentReconciliation.meta",
"path" : "PaymentReconciliation.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "PaymentReconciliation.implicitRules",
"path" : "PaymentReconciliation.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "PaymentReconciliation.language",
"path" : "PaymentReconciliation.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "PaymentReconciliation.text",
"path" : "PaymentReconciliation.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "PaymentReconciliation.contained",
"path" : "PaymentReconciliation.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "PaymentReconciliation.extension",
"path" : "PaymentReconciliation.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "PaymentReconciliation.modifierExtension",
"path" : "PaymentReconciliation.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "PaymentReconciliation.identifier",
"path" : "PaymentReconciliation.identifier",
"short" : "Business Identifier for a payment reconciliation",
"definition" : "A unique identifier assigned to this payment reconciliation.",
"requirements" : "Allows payment reconciliations to be distinguished and referenced.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "PaymentReconciliation.identifier",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Identifier"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.identifier"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
}]
},
{
"id" : "PaymentReconciliation.status",
"path" : "PaymentReconciliation.status",
"short" : "active | cancelled | draft | entered-in-error",
"definition" : "The status of the resource instance.",
"comment" : "This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.",
"requirements" : "Need to track the status of the resource as 'draft' resources may undergo further edits while 'active' resources are immutable and may only have their status changed to 'cancelled'.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "PaymentReconciliation.status",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "PaymentReconciliationStatus"
}],
"strength" : "required",
"description" : "A code specifying the state of the resource instance.",
"valueSet" : "http://hl7.org/fhir/ValueSet/fm-status|4.0.1"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.status"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
}]
},
{
"id" : "PaymentReconciliation.period",
"path" : "PaymentReconciliation.period",
"short" : "Period covered",
"definition" : "The period of time for which payments have been gathered into this bulk payment for settlement.",
"requirements" : "Needed to allow receivers to monitor and reconcile payment issuer schedules.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "PaymentReconciliation.period",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Period"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.done[x]"
}]
},
{
"id" : "PaymentReconciliation.created",
"path" : "PaymentReconciliation.created",
"short" : "Creation date",
"definition" : "The date when the resource was created.",
"requirements" : "Need to record a timestamp for use by both the recipient and the issuer.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "PaymentReconciliation.created",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.occurrence[x]"
},
{
"identity" : "w5",
"map" : "FiveWs.recorded"
}]
},
{
"id" : "PaymentReconciliation.paymentIssuer",
"path" : "PaymentReconciliation.paymentIssuer",
"short" : "Party generating payment",
"definition" : "The party who generated the payment.",
"comment" : "This party is also responsible for the reconciliation.",
"requirements" : "Need to identify the party resonsible for the payment and this resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "PaymentReconciliation.paymentIssuer",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.performer.actor"
},
{
"identity" : "w5",
"map" : "FiveWs.source"
}]
},
{
"id" : "PaymentReconciliation.request",
"path" : "PaymentReconciliation.request",
"short" : "Reference to requesting resource",
"definition" : "Original request resource reference.",
"requirements" : "Needed to allow the response to be linked to the request.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "PaymentReconciliation.request",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Task"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "cdanetv4",
"map" : "A02|G01"
}]
},
{
"id" : "PaymentReconciliation.requestor",
"path" : "PaymentReconciliation.requestor",
"short" : "Responsible practitioner",
"definition" : "The practitioner who is responsible for the services rendered to the patient.",
"requirements" : "Need to identify the party responsible for the request.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "PaymentReconciliation.requestor",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "cdanetv4",
"map" : "B01"
}]
},
{
"id" : "PaymentReconciliation.outcome",
"path" : "PaymentReconciliation.outcome",
"short" : "queued | complete | error | partial",
"definition" : "The outcome of a request for a reconciliation.",
"comment" : "The resource may be used to indicate that: the request has been held (queued) for processing; that it has been processed and errors found (error); that no errors were found and that some of the adjudication has been undertaken (partial) or that all of the adjudication has been undertaken (complete).",
"requirements" : "To advise the requestor of an overall processing outcome.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "PaymentReconciliation.outcome",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "RemittanceOutcome"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "The outcome of the processing.",
"valueSet" : "http://hl7.org/fhir/ValueSet/remittance-outcome|4.0.1"
}
},
{
"id" : "PaymentReconciliation.disposition",
"path" : "PaymentReconciliation.disposition",
"short" : "Disposition message",
"definition" : "A human readable description of the status of the request for the reconciliation.",
"requirements" : "Provided for user display.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "PaymentReconciliation.disposition",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.note"
}]
},
{
"id" : "PaymentReconciliation.paymentDate",
"path" : "PaymentReconciliation.paymentDate",
"short" : "When payment issued",
"definition" : "The date of payment as indicated on the financial instrument.",
"requirements" : "To advise the payee when payment can be expected.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "PaymentReconciliation.paymentDate",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "date"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "PaymentReconciliation.paymentAmount",
"path" : "PaymentReconciliation.paymentAmount",
"short" : "Total amount of Payment",
"definition" : "Total payment amount as indicated on the financial instrument.",
"requirements" : "Needed to provide the actual payment amount.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "PaymentReconciliation.paymentAmount",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "Money"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "PaymentReconciliation.paymentIdentifier",
"path" : "PaymentReconciliation.paymentIdentifier",
"short" : "Business identifier for the payment",
"definition" : "Issuer's unique identifier for the payment instrument.",
"comment" : "For example: EFT number or check number.",
"requirements" : "Enable the receiver to reconcile when payment is received.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "PaymentReconciliation.paymentIdentifier",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Identifier"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "PaymentReconciliation.detail",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "Details"
}],
"path" : "PaymentReconciliation.detail",
"short" : "Settlement particulars",
"definition" : "Distribution of the payment amount for a previously acknowledged payable.",
"requirements" : "Needed to show how the payment amount is distributed across the payables.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "PaymentReconciliation.detail",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "PaymentReconciliation.detail.id",
"path" : "PaymentReconciliation.detail.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "PaymentReconciliation.detail.extension",
"path" : "PaymentReconciliation.detail.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "PaymentReconciliation.detail.modifierExtension",
"path" : "PaymentReconciliation.detail.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "PaymentReconciliation.detail.identifier",
"path" : "PaymentReconciliation.detail.identifier",
"short" : "Business identifier of the payment detail",
"definition" : "Unique identifier for the current payment item for the referenced payable.",
"requirements" : "Needed for reconciliation of payments.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "PaymentReconciliation.detail.identifier",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Identifier"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "PaymentReconciliation.detail.predecessor",
"path" : "PaymentReconciliation.detail.predecessor",
"short" : "Business identifier of the prior payment detail",
"definition" : "Unique identifier for the prior payment item for the referenced payable.",
"requirements" : "Needed for reconciliation of payments.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "PaymentReconciliation.detail.predecessor",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Identifier"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "PaymentReconciliation.detail.type",
"path" : "PaymentReconciliation.detail.type",
"short" : "Category of payment",
"definition" : "Code to indicate the nature of the payment.",
"comment" : "For example: payment, adjustment, funds advance, etc.",
"requirements" : "Needed to provide context for the amount.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "PaymentReconciliation.detail.type",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "PaymentType"
}],
"strength" : "example",
"description" : "The reason for the amount: payment, adjustment, advance.",
"valueSet" : "http://hl7.org/fhir/ValueSet/payment-type"
}
},
{
"id" : "PaymentReconciliation.detail.request",
"path" : "PaymentReconciliation.detail.request",
"short" : "Request giving rise to the payment",
"definition" : "A resource, such as a Claim, the evaluation of which could lead to payment.",
"requirements" : "Needed to provide a linkage to the original request.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "PaymentReconciliation.detail.request",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "PaymentReconciliation.detail.submitter",
"path" : "PaymentReconciliation.detail.submitter",
"short" : "Submitter of the request",
"definition" : "The party which submitted the claim or financial transaction.",
"requirements" : "Needed for audit and validation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "PaymentReconciliation.detail.submitter",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "PaymentReconciliation.detail.response",
"path" : "PaymentReconciliation.detail.response",
"short" : "Response committing to a payment",
"definition" : "A resource, such as a ClaimResponse, which contains a commitment to payment.",
"requirements" : "Needed to provide a linkage to the payment commitment.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "PaymentReconciliation.detail.response",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "PaymentReconciliation.detail.date",
"path" : "PaymentReconciliation.detail.date",
"short" : "Date of commitment to pay",
"definition" : "The date from the response resource containing a commitment to pay.",
"requirements" : "Needed for audit and validation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "PaymentReconciliation.detail.date",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "date"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "PaymentReconciliation.detail.responsible",
"path" : "PaymentReconciliation.detail.responsible",
"short" : "Contact for the response",
"definition" : "A reference to the individual who is responsible for inquiries regarding the response and its payment.",
"requirements" : "To provide contact information.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "PaymentReconciliation.detail.responsible",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/PractitionerRole"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "PaymentReconciliation.detail.payee",
"path" : "PaymentReconciliation.detail.payee",
"short" : "Recipient of the payment",
"definition" : "The party which is receiving the payment.",
"requirements" : "Needed for audit and validation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "PaymentReconciliation.detail.payee",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "PaymentReconciliation.detail.amount",
"path" : "PaymentReconciliation.detail.amount",
"short" : "Amount allocated to this payable",
"definition" : "The monetary amount allocated from the total payment to the payable.",
"requirements" : "Needed to explain the distribution of the payment to the payables.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "PaymentReconciliation.detail.amount",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Money"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "PaymentReconciliation.formCode",
"path" : "PaymentReconciliation.formCode",
"short" : "Printed form identifier",
"definition" : "A code for the form to be used for printing the content.",
"comment" : "May be needed to identify specific jurisdictional forms.",
"requirements" : "Needed to specify the specific form used for producing output for this response.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "PaymentReconciliation.formCode",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Forms"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "example",
"description" : "The forms codes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/forms"
}
},
{
"id" : "PaymentReconciliation.processNote",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "Notes"
}],
"path" : "PaymentReconciliation.processNote",
"short" : "Note concerning processing",
"definition" : "A note that describes or explains the processing in a human readable form.",
"requirements" : "Provides the specific textual explanations associated with the processing.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "PaymentReconciliation.processNote",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "PaymentReconciliation.processNote.id",
"path" : "PaymentReconciliation.processNote.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "PaymentReconciliation.processNote.extension",
"path" : "PaymentReconciliation.processNote.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "PaymentReconciliation.processNote.modifierExtension",
"path" : "PaymentReconciliation.processNote.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "PaymentReconciliation.processNote.type",
"path" : "PaymentReconciliation.processNote.type",
"short" : "display | print | printoper",
"definition" : "The business purpose of the note text.",
"requirements" : "To convey the expectation for when the text is used.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "PaymentReconciliation.processNote.type",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "NoteType"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "The presentation types of notes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/note-type|4.0.1"
}
},
{
"id" : "PaymentReconciliation.processNote.text",
"path" : "PaymentReconciliation.processNote.text",
"short" : "Note explanatory text",
"definition" : "The explanation or description associated with the processing.",
"requirements" : "Required to provide human readable explanation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "PaymentReconciliation.processNote.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "cdanetv4",
"map" : "G32"
}]
}]
},
"differential" : {
"element" : [{
"id" : "PaymentReconciliation",
"path" : "PaymentReconciliation",
"short" : "PaymentReconciliation resource",
"definition" : "This resource provides the details including amount of a payment and allocates the payment items being paid.",
"min" : 0,
"max" : "*",
"mapping" : [{
"identity" : "workflow",
"map" : "Event"
}]
},
{
"id" : "PaymentReconciliation.identifier",
"path" : "PaymentReconciliation.identifier",
"short" : "Business Identifier for a payment reconciliation",
"definition" : "A unique identifier assigned to this payment reconciliation.",
"requirements" : "Allows payment reconciliations to be distinguished and referenced.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Identifier"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Event.identifier"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
}]
},
{
"id" : "PaymentReconciliation.status",
"path" : "PaymentReconciliation.status",
"short" : "active | cancelled | draft | entered-in-error",
"definition" : "The status of the resource instance.",
"comment" : "This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.",
"requirements" : "Need to track the status of the resource as 'draft' resources may undergo further edits while 'active' resources are immutable and may only have their status changed to 'cancelled'.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isModifier" : true,
"isModifierReason" : "This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "PaymentReconciliationStatus"
}],
"strength" : "required",
"description" : "A code specifying the state of the resource instance.",
"valueSet" : "http://hl7.org/fhir/ValueSet/fm-status|4.0.1"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.status"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
}]
},
{
"id" : "PaymentReconciliation.period",
"path" : "PaymentReconciliation.period",
"short" : "Period covered",
"definition" : "The period of time for which payments have been gathered into this bulk payment for settlement.",
"requirements" : "Needed to allow receivers to monitor and reconcile payment issuer schedules.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Period"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.done[x]"
}]
},
{
"id" : "PaymentReconciliation.created",
"path" : "PaymentReconciliation.created",
"short" : "Creation date",
"definition" : "The date when the resource was created.",
"requirements" : "Need to record a timestamp for use by both the recipient and the issuer.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "dateTime"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.occurrence[x]"
},
{
"identity" : "w5",
"map" : "FiveWs.recorded"
}]
},
{
"id" : "PaymentReconciliation.paymentIssuer",
"path" : "PaymentReconciliation.paymentIssuer",
"short" : "Party generating payment",
"definition" : "The party who generated the payment.",
"comment" : "This party is also responsible for the reconciliation.",
"requirements" : "Need to identify the party resonsible for the payment and this resource.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.performer.actor"
},
{
"identity" : "w5",
"map" : "FiveWs.source"
}]
},
{
"id" : "PaymentReconciliation.request",
"path" : "PaymentReconciliation.request",
"short" : "Reference to requesting resource",
"definition" : "Original request resource reference.",
"requirements" : "Needed to allow the response to be linked to the request.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Task"]
}],
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "cdanetv4",
"map" : "A02|G01"
}]
},
{
"id" : "PaymentReconciliation.requestor",
"path" : "PaymentReconciliation.requestor",
"short" : "Responsible practitioner",
"definition" : "The practitioner who is responsible for the services rendered to the patient.",
"requirements" : "Need to identify the party responsible for the request.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"mapping" : [{
"identity" : "cdanetv4",
"map" : "B01"
}]
},
{
"id" : "PaymentReconciliation.outcome",
"path" : "PaymentReconciliation.outcome",
"short" : "queued | complete | error | partial",
"definition" : "The outcome of a request for a reconciliation.",
"comment" : "The resource may be used to indicate that: the request has been held (queued) for processing; that it has been processed and errors found (error); that no errors were found and that some of the adjudication has been undertaken (partial) or that all of the adjudication has been undertaken (complete).",
"requirements" : "To advise the requestor of an overall processing outcome.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "code"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "RemittanceOutcome"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "The outcome of the processing.",
"valueSet" : "http://hl7.org/fhir/ValueSet/remittance-outcome|4.0.1"
}
},
{
"id" : "PaymentReconciliation.disposition",
"path" : "PaymentReconciliation.disposition",
"short" : "Disposition message",
"definition" : "A human readable description of the status of the request for the reconciliation.",
"requirements" : "Provided for user display.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Event.note"
}]
},
{
"id" : "PaymentReconciliation.paymentDate",
"path" : "PaymentReconciliation.paymentDate",
"short" : "When payment issued",
"definition" : "The date of payment as indicated on the financial instrument.",
"requirements" : "To advise the payee when payment can be expected.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "date"
}],
"isSummary" : true
},
{
"id" : "PaymentReconciliation.paymentAmount",
"path" : "PaymentReconciliation.paymentAmount",
"short" : "Total amount of Payment",
"definition" : "Total payment amount as indicated on the financial instrument.",
"requirements" : "Needed to provide the actual payment amount.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "Money"
}],
"isSummary" : true
},
{
"id" : "PaymentReconciliation.paymentIdentifier",
"path" : "PaymentReconciliation.paymentIdentifier",
"short" : "Business identifier for the payment",
"definition" : "Issuer's unique identifier for the payment instrument.",
"comment" : "For example: EFT number or check number.",
"requirements" : "Enable the receiver to reconcile when payment is received.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Identifier"
}]
},
{
"id" : "PaymentReconciliation.detail",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "Details"
}],
"path" : "PaymentReconciliation.detail",
"short" : "Settlement particulars",
"definition" : "Distribution of the payment amount for a previously acknowledged payable.",
"requirements" : "Needed to show how the payment amount is distributed across the payables.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "PaymentReconciliation.detail.identifier",
"path" : "PaymentReconciliation.detail.identifier",
"short" : "Business identifier of the payment detail",
"definition" : "Unique identifier for the current payment item for the referenced payable.",
"requirements" : "Needed for reconciliation of payments.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Identifier"
}]
},
{
"id" : "PaymentReconciliation.detail.predecessor",
"path" : "PaymentReconciliation.detail.predecessor",
"short" : "Business identifier of the prior payment detail",
"definition" : "Unique identifier for the prior payment item for the referenced payable.",
"requirements" : "Needed for reconciliation of payments.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Identifier"
}]
},
{
"id" : "PaymentReconciliation.detail.type",
"path" : "PaymentReconciliation.detail.type",
"short" : "Category of payment",
"definition" : "Code to indicate the nature of the payment.",
"comment" : "For example: payment, adjustment, funds advance, etc.",
"requirements" : "Needed to provide context for the amount.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "PaymentType"
}],
"strength" : "example",
"description" : "The reason for the amount: payment, adjustment, advance.",
"valueSet" : "http://hl7.org/fhir/ValueSet/payment-type"
}
},
{
"id" : "PaymentReconciliation.detail.request",
"path" : "PaymentReconciliation.detail.request",
"short" : "Request giving rise to the payment",
"definition" : "A resource, such as a Claim, the evaluation of which could lead to payment.",
"requirements" : "Needed to provide a linkage to the original request.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}]
},
{
"id" : "PaymentReconciliation.detail.submitter",
"path" : "PaymentReconciliation.detail.submitter",
"short" : "Submitter of the request",
"definition" : "The party which submitted the claim or financial transaction.",
"requirements" : "Needed for audit and validation.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Organization"]
}]
},
{
"id" : "PaymentReconciliation.detail.response",
"path" : "PaymentReconciliation.detail.response",
"short" : "Response committing to a payment",
"definition" : "A resource, such as a ClaimResponse, which contains a commitment to payment.",
"requirements" : "Needed to provide a linkage to the payment commitment.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}]
},
{
"id" : "PaymentReconciliation.detail.date",
"path" : "PaymentReconciliation.detail.date",
"short" : "Date of commitment to pay",
"definition" : "The date from the response resource containing a commitment to pay.",
"requirements" : "Needed for audit and validation.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "date"
}]
},
{
"id" : "PaymentReconciliation.detail.responsible",
"path" : "PaymentReconciliation.detail.responsible",
"short" : "Contact for the response",
"definition" : "A reference to the individual who is responsible for inquiries regarding the response and its payment.",
"requirements" : "To provide contact information.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/PractitionerRole"]
}]
},
{
"id" : "PaymentReconciliation.detail.payee",
"path" : "PaymentReconciliation.detail.payee",
"short" : "Recipient of the payment",
"definition" : "The party which is receiving the payment.",
"requirements" : "Needed for audit and validation.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Organization"]
}]
},
{
"id" : "PaymentReconciliation.detail.amount",
"path" : "PaymentReconciliation.detail.amount",
"short" : "Amount allocated to this payable",
"definition" : "The monetary amount allocated from the total payment to the payable.",
"requirements" : "Needed to explain the distribution of the payment to the payables.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Money"
}]
},
{
"id" : "PaymentReconciliation.formCode",
"path" : "PaymentReconciliation.formCode",
"short" : "Printed form identifier",
"definition" : "A code for the form to be used for printing the content.",
"comment" : "May be needed to identify specific jurisdictional forms.",
"requirements" : "Needed to specify the specific form used for producing output for this response.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Forms"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "example",
"description" : "The forms codes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/forms"
}
},
{
"id" : "PaymentReconciliation.processNote",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "Notes"
}],
"path" : "PaymentReconciliation.processNote",
"short" : "Note concerning processing",
"definition" : "A note that describes or explains the processing in a human readable form.",
"requirements" : "Provides the specific textual explanations associated with the processing.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "PaymentReconciliation.processNote.type",
"path" : "PaymentReconciliation.processNote.type",
"short" : "display | print | printoper",
"definition" : "The business purpose of the note text.",
"requirements" : "To convey the expectation for when the text is used.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "code"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "NoteType"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "The presentation types of notes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/note-type|4.0.1"
}
},
{
"id" : "PaymentReconciliation.processNote.text",
"path" : "PaymentReconciliation.processNote.text",
"short" : "Note explanatory text",
"definition" : "The explanation or description associated with the processing.",
"requirements" : "Required to provide human readable explanation.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"mapping" : [{
"identity" : "cdanetv4",
"map" : "G32"
}]
}]
}
}
},
{
"fullUrl" : "http://hl7.org/fhir/StructureDefinition/Person",
"resource" : {
"resourceType" : "StructureDefinition",
"id" : "Person",
"meta" : {
"lastUpdated" : "2019-11-01T09:29:23.356+11:00"
},
"text" : {
"status" : "generated",
"div" : "Name Flags Card. Type Description & Constraints Person TU DomainResource A generic person record
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension identifier 0..* Identifier A human identifier for this person
name Σ 0..* HumanName A name associated with the person
telecom Σ 0..* ContactPoint A contact detail for the person
gender Σ 0..1 code male | female | other | unknown
AdministrativeGender (Required) birthDate Σ 0..1 date The date on which the person was born address 0..* Address One or more addresses for the person
photo 0..1 Attachment Image of the person managingOrganization Σ 0..1 Reference(Organization) The organization that is the custodian of the person record active ?!Σ 0..1 boolean This person's record is in active use link 0..* BackboneElement Link to a resource that concerns the same actual person
target 1..1 Reference(Patient | Practitioner | RelatedPerson | Person) The resource to which this actual person is associated assurance 0..1 code level1 | level2 | level3 | level4
IdentityAssuranceLevel (Required)
Documentation for this format
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Base.Individuals"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 2
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "patient"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "pa"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/Person",
"version" : "4.0.1",
"name" : "Person",
"status" : "draft",
"date" : "2019-11-01T09:29:23+11:00",
"publisher" : "Health Level Seven International (Patient Administration)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/pafm/index.cfm"
}]
}],
"description" : "Demographics and administrative information about a person independent of a specific health-related context.",
"purpose" : "Need to track persons potentially across multiple roles.",
"fhirVersion" : "4.0.1",
"mapping" : [{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/fivews",
"name" : "FiveWs Pattern Mapping"
},
{
"identity" : "v2",
"uri" : "http://hl7.org/v2",
"name" : "HL7 v2 Mapping"
}],
"kind" : "resource",
"abstract" : false,
"type" : "Person",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "Person",
"path" : "Person",
"short" : "A generic person record",
"definition" : "Demographics and administrative information about a person independent of a specific health-related context.",
"comment" : "The Person resource does justice to person registries that keep track of persons regardless of their role. The Person resource is also a primary resource to point to for people acting in a particular role such as SubjectofCare, Practitioner, and Agent. Very few attributes are specific to any role and so Person is kept lean. Most attributes are expected to be tied to the role the Person plays rather than the Person himself. Examples of that are Guardian (SubjectofCare), ContactParty (SubjectOfCare, Practitioner), and multipleBirthInd (SubjectofCare).",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Person",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "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",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.`div`.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "rim",
"map" : "Person(classCode=\"PSN\" and determinerCode=\"INST\" and quantity=\"1\")"
}]
},
{
"id" : "Person.id",
"path" : "Person.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Person.meta",
"path" : "Person.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Person.implicitRules",
"path" : "Person.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "Person.language",
"path" : "Person.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "Person.text",
"path" : "Person.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "Person.contained",
"path" : "Person.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Person.extension",
"path" : "Person.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Person.modifierExtension",
"path" : "Person.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Person.identifier",
"path" : "Person.identifier",
"short" : "A human identifier for this person",
"definition" : "Identifier for a person within a particular scope.",
"requirements" : "People are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the person. Examples are national person identifier and local identifier.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Person.identifier",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Identifier"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "v2",
"map" : "PID-3"
},
{
"identity" : "rim",
"map" : ".plays:Role(classCode='IDENT').id"
}]
},
{
"id" : "Person.name",
"path" : "Person.name",
"short" : "A name associated with the person",
"definition" : "A name associated with the person.",
"comment" : "Person may have multiple names with different uses or applicable periods.",
"requirements" : "Need to be able to track the person by multiple names. Examples are your official name and a partner name.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Person.name",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "HumanName"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "v2",
"map" : "PID-5, PID-9"
},
{
"identity" : "rim",
"map" : "./name"
}]
},
{
"id" : "Person.telecom",
"path" : "Person.telecom",
"short" : "A contact detail for the person",
"definition" : "A contact detail for the person, e.g. a telephone number or an email address.",
"comment" : "Person may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and also to help with identification.",
"requirements" : "People have (primary) ways to contact them in some way such as phone, email.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Person.telecom",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "ContactPoint"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "v2",
"map" : "PID-13, PID-14"
},
{
"identity" : "rim",
"map" : "./telecom"
}]
},
{
"id" : "Person.gender",
"path" : "Person.gender",
"short" : "male | female | other | unknown",
"definition" : "Administrative Gender.",
"comment" : "The gender might not match the biological sex as determined by genetics, or the individual's preferred identification. Note that for both humans and particularly animals, there are other legitimate possibilities than M and F, though a clear majority of systems and contexts only support M and F.",
"requirements" : "Needed for identification of the person, in combination with (at least) name and birth date. Gender of person drives many clinical processes.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Person.gender",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AdministrativeGender"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "The gender of a person used for administrative purposes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1"
},
"mapping" : [{
"identity" : "v2",
"map" : "PID-8"
},
{
"identity" : "rim",
"map" : "player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender"
}]
},
{
"id" : "Person.birthDate",
"path" : "Person.birthDate",
"short" : "The date on which the person was born",
"definition" : "The birth date for the person.",
"comment" : "At least an estimated year should be provided as a guess if the real DOB is unknown.",
"requirements" : "Age of person drives many clinical processes, and is often used in performing identification of the person. Times are not included so as to not confuse things with potential timezone issues.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Person.birthDate",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "date"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "v2",
"map" : "PID-7"
},
{
"identity" : "rim",
"map" : "./birthTime"
}]
},
{
"id" : "Person.address",
"path" : "Person.address",
"short" : "One or more addresses for the person",
"definition" : "One or more addresses for the person.",
"comment" : "Person may have multiple addresses with different uses or applicable periods.",
"requirements" : "May need to keep track of person's addresses for contacting, billing or reporting requirements and also to help with identification.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Person.address",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Address"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "PID-11"
},
{
"identity" : "rim",
"map" : "./addr"
}]
},
{
"id" : "Person.photo",
"path" : "Person.photo",
"short" : "Image of the person",
"definition" : "An image that can be displayed as a thumbnail of the person to enhance the identification of the individual.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Person.photo",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Attachment"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "OBX-5 - needs a profile"
},
{
"identity" : "rim",
"map" : "player[classCode=PSN|ANM and determinerCode=INSTANCE]/desc"
}]
},
{
"id" : "Person.managingOrganization",
"path" : "Person.managingOrganization",
"short" : "The organization that is the custodian of the person record",
"definition" : "The organization that is the custodian of the person record.",
"requirements" : "Need to know who recognizes this person record, manages and updates it.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Person.managingOrganization",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "scoper"
}]
},
{
"id" : "Person.active",
"path" : "Person.active",
"short" : "This person's record is in active use",
"definition" : "Whether this person's record is in active use.",
"requirements" : "Need to be able to mark a person record as not to be used because it was created in error.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Person.active",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid",
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.status"
},
{
"identity" : "rim",
"map" : "statusCode"
}]
},
{
"id" : "Person.link",
"path" : "Person.link",
"short" : "Link to a resource that concerns the same actual person",
"definition" : "Link to a resource that concerns the same actual person.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Person.link",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "outboundLink"
}]
},
{
"id" : "Person.link.id",
"path" : "Person.link.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Person.link.extension",
"path" : "Person.link.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Person.link.modifierExtension",
"path" : "Person.link.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Person.link.target",
"path" : "Person.link.target",
"short" : "The resource to which this actual person is associated",
"definition" : "The resource to which this actual person is associated.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Person.link.target",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson",
"http://hl7.org/fhir/StructureDefinition/Person"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "id"
}]
},
{
"id" : "Person.link.assurance",
"path" : "Person.link.assurance",
"short" : "level1 | level2 | level3 | level4",
"definition" : "Level of assurance that this link is associated with the target resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Person.link.assurance",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "IdentityAssuranceLevel"
}],
"strength" : "required",
"description" : "The level of confidence that this link represents the same actual person, based on NIST Authentication Levels.",
"valueSet" : "http://hl7.org/fhir/ValueSet/identity-assuranceLevel|4.0.1"
},
"mapping" : [{
"identity" : "rim",
"map" : "priorityNumber?"
}]
}]
},
"differential" : {
"element" : [{
"id" : "Person",
"path" : "Person",
"short" : "A generic person record",
"definition" : "Demographics and administrative information about a person independent of a specific health-related context.",
"comment" : "The Person resource does justice to person registries that keep track of persons regardless of their role. The Person resource is also a primary resource to point to for people acting in a particular role such as SubjectofCare, Practitioner, and Agent. Very few attributes are specific to any role and so Person is kept lean. Most attributes are expected to be tied to the role the Person plays rather than the Person himself. Examples of that are Guardian (SubjectofCare), ContactParty (SubjectOfCare, Practitioner), and multipleBirthInd (SubjectofCare).",
"min" : 0,
"max" : "*",
"mapping" : [{
"identity" : "rim",
"map" : "Person(classCode=\"PSN\" and determinerCode=\"INST\" and quantity=\"1\")"
}]
},
{
"id" : "Person.identifier",
"path" : "Person.identifier",
"short" : "A human identifier for this person",
"definition" : "Identifier for a person within a particular scope.",
"requirements" : "People are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the person. Examples are national person identifier and local identifier.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Identifier"
}],
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "v2",
"map" : "PID-3"
},
{
"identity" : "rim",
"map" : ".plays:Role(classCode='IDENT').id"
}]
},
{
"id" : "Person.name",
"path" : "Person.name",
"short" : "A name associated with the person",
"definition" : "A name associated with the person.",
"comment" : "Person may have multiple names with different uses or applicable periods.",
"requirements" : "Need to be able to track the person by multiple names. Examples are your official name and a partner name.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "HumanName"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "v2",
"map" : "PID-5, PID-9"
},
{
"identity" : "rim",
"map" : "./name"
}]
},
{
"id" : "Person.telecom",
"path" : "Person.telecom",
"short" : "A contact detail for the person",
"definition" : "A contact detail for the person, e.g. a telephone number or an email address.",
"comment" : "Person may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and also to help with identification.",
"requirements" : "People have (primary) ways to contact them in some way such as phone, email.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "ContactPoint"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "v2",
"map" : "PID-13, PID-14"
},
{
"identity" : "rim",
"map" : "./telecom"
}]
},
{
"id" : "Person.gender",
"path" : "Person.gender",
"short" : "male | female | other | unknown",
"definition" : "Administrative Gender.",
"comment" : "The gender might not match the biological sex as determined by genetics, or the individual's preferred identification. Note that for both humans and particularly animals, there are other legitimate possibilities than M and F, though a clear majority of systems and contexts only support M and F.",
"requirements" : "Needed for identification of the person, in combination with (at least) name and birth date. Gender of person drives many clinical processes.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AdministrativeGender"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "The gender of a person used for administrative purposes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1"
},
"mapping" : [{
"identity" : "v2",
"map" : "PID-8"
},
{
"identity" : "rim",
"map" : "player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender"
}]
},
{
"id" : "Person.birthDate",
"path" : "Person.birthDate",
"short" : "The date on which the person was born",
"definition" : "The birth date for the person.",
"comment" : "At least an estimated year should be provided as a guess if the real DOB is unknown.",
"requirements" : "Age of person drives many clinical processes, and is often used in performing identification of the person. Times are not included so as to not confuse things with potential timezone issues.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "date"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "v2",
"map" : "PID-7"
},
{
"identity" : "rim",
"map" : "./birthTime"
}]
},
{
"id" : "Person.address",
"path" : "Person.address",
"short" : "One or more addresses for the person",
"definition" : "One or more addresses for the person.",
"comment" : "Person may have multiple addresses with different uses or applicable periods.",
"requirements" : "May need to keep track of person's addresses for contacting, billing or reporting requirements and also to help with identification.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Address"
}],
"mapping" : [{
"identity" : "v2",
"map" : "PID-11"
},
{
"identity" : "rim",
"map" : "./addr"
}]
},
{
"id" : "Person.photo",
"path" : "Person.photo",
"short" : "Image of the person",
"definition" : "An image that can be displayed as a thumbnail of the person to enhance the identification of the individual.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Attachment"
}],
"mapping" : [{
"identity" : "v2",
"map" : "OBX-5 - needs a profile"
},
{
"identity" : "rim",
"map" : "player[classCode=PSN|ANM and determinerCode=INSTANCE]/desc"
}]
},
{
"id" : "Person.managingOrganization",
"path" : "Person.managingOrganization",
"short" : "The organization that is the custodian of the person record",
"definition" : "The organization that is the custodian of the person record.",
"requirements" : "Need to know who recognizes this person record, manages and updates it.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "scoper"
}]
},
{
"id" : "Person.active",
"path" : "Person.active",
"short" : "This person's record is in active use",
"definition" : "Whether this person's record is in active use.",
"requirements" : "Need to be able to mark a person record as not to be used because it was created in error.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "boolean"
}],
"isModifier" : true,
"isModifierReason" : "This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid",
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.status"
},
{
"identity" : "rim",
"map" : "statusCode"
}]
},
{
"id" : "Person.link",
"path" : "Person.link",
"short" : "Link to a resource that concerns the same actual person",
"definition" : "Link to a resource that concerns the same actual person.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"mapping" : [{
"identity" : "rim",
"map" : "outboundLink"
}]
},
{
"id" : "Person.link.target",
"path" : "Person.link.target",
"short" : "The resource to which this actual person is associated",
"definition" : "The resource to which this actual person is associated.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson",
"http://hl7.org/fhir/StructureDefinition/Person"]
}],
"mapping" : [{
"identity" : "rim",
"map" : "id"
}]
},
{
"id" : "Person.link.assurance",
"path" : "Person.link.assurance",
"short" : "level1 | level2 | level3 | level4",
"definition" : "Level of assurance that this link is associated with the target resource.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "code"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "IdentityAssuranceLevel"
}],
"strength" : "required",
"description" : "The level of confidence that this link represents the same actual person, based on NIST Authentication Levels.",
"valueSet" : "http://hl7.org/fhir/ValueSet/identity-assuranceLevel|4.0.1"
},
"mapping" : [{
"identity" : "rim",
"map" : "priorityNumber?"
}]
}]
}
}
},
{
"fullUrl" : "http://hl7.org/fhir/StructureDefinition/PlanDefinition",
"resource" : {
"resourceType" : "StructureDefinition",
"id" : "PlanDefinition",
"meta" : {
"lastUpdated" : "2019-11-01T09:29:23.356+11:00"
},
"text" : {
"status" : "generated",
"div" : "Name Flags Card. Type Description & Constraints PlanDefinition ITU 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
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension url Σ 0..1 uri Canonical identifier for this plan definition, represented as a URI (globally unique) identifier Σ 0..* Identifier Additional identifier for the plan definition
version Σ 0..1 string Business version of the plan definition name ΣI 0..1 string Name for this plan definition (computer friendly) title Σ 0..1 string Name for this plan definition (human friendly) subtitle 0..1 string Subordinate title of the plan definition type Σ 0..1 CodeableConcept order-set | clinical-protocol | eca-rule | workflow-definition
PlanDefinitionType (Extensible) status ?!Σ 1..1 code draft | active | retired | unknown
PublicationStatus (Required) experimental Σ 0..1 boolean For testing purposes, not real usage subject[x] 0..1 Type of individual the plan definition is focused on
Subject type (Extensible) subjectCodeableConcept CodeableConcept subjectReference Reference(Group) date Σ 0..1 dateTime Date last changed publisher Σ 0..1 string Name of the publisher (organization or individual) contact Σ 0..* ContactDetail Contact details for the publisher
description Σ 0..1 markdown Natural language description of the plan definition useContext Σ 0..* UsageContext The context that the content is intended to support
jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for plan definition (if applicable)
Jurisdiction (Extensible)
purpose 0..1 markdown Why this plan definition is defined usage 0..1 string Describes the clinical usage of the plan copyright 0..1 markdown Use and/or publishing restrictions approvalDate 0..1 date When the plan definition was approved by publisher lastReviewDate 0..1 date When the plan definition was last reviewed effectivePeriod Σ 0..1 Period When the plan definition is expected to be used topic 0..* CodeableConcept E.g. Education, Treatment, Assessment
DefinitionTopic (Example)
author 0..* ContactDetail Who authored the content
editor 0..* ContactDetail Who edited the content
reviewer 0..* ContactDetail Who reviewed the content
endorser 0..* ContactDetail Who endorsed the content
relatedArtifact 0..* RelatedArtifact Additional documentation, citations
library 0..* canonical(Library) Logic used by the plan definition
goal 0..* BackboneElement What the plan is trying to accomplish
category 0..1 CodeableConcept E.g. Treatment, dietary, behavioral
Goal category (Example) description 1..1 CodeableConcept Code or text describing the goal
SNOMED CT Clinical Findings (Example) priority 0..1 CodeableConcept high-priority | medium-priority | low-priority
Goal priority (Preferred) start 0..1 CodeableConcept When goal pursuit begins
Goal start event (Example) addresses 0..* CodeableConcept What does the goal address
Condition/Problem/Diagnosis Codes (Example)
documentation 0..* RelatedArtifact Supporting documentation for the goal
target 0..* BackboneElement Target outcome for the goal
measure 0..1 CodeableConcept The parameter whose value is to be tracked
LOINC Codes (Example) detail[x] 0..1 The target value to be achieved detailQuantity Quantity detailRange Range detailCodeableConcept CodeableConcept due 0..1 Duration Reach goal within action 0..* BackboneElement Action defined by the plan
prefix 0..1 string User-visible prefix for the action (e.g. 1. or A.) title 0..1 string User-visible title description 0..1 string Brief description of the action textEquivalent 0..1 string Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system priority 0..1 code routine | urgent | asap | stat
Request priority (Required) code 0..* CodeableConcept Code representing the meaning of the action or sub-actions
reason 0..* CodeableConcept Why the action should be performed
documentation 0..* RelatedArtifact Supporting documentation for the intended performer of the action
goalId 0..* id What goals this action supports
subject[x] 0..1 Type of individual the action is focused on
Subject type (Extensible) subjectCodeableConcept CodeableConcept subjectReference Reference(Group) trigger 0..* TriggerDefinition When the action should be triggered
condition 0..* BackboneElement Whether or not the action is applicable
kind 1..1 code applicability | start | stop
ActionConditionKind (Required) expression 0..1 Expression Boolean-valued expression input 0..* DataRequirement Input data requirements
output 0..* DataRequirement Output data definition
relatedAction 0..* BackboneElement Relationship to another action
actionId 1..1 id What action is this related to relationship 1..1 code before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
ActionRelationshipType (Required) offset[x] 0..1 Time offset for the relationship offsetDuration Duration offsetRange Range timing[x] 0..1 When the action should take place timingDateTime dateTime timingAge Age timingPeriod Period timingDuration Duration timingRange Range timingTiming Timing participant 0..* BackboneElement Who should participate in the action
type 1..1 code patient | practitioner | related-person | device
ActionParticipantType (Required) role 0..1 CodeableConcept E.g. Nurse, Surgeon, Parent
Action participant role (Example) type 0..1 CodeableConcept create | update | remove | fire-event
ActionType (Extensible) groupingBehavior 0..1 code visual-group | logical-group | sentence-group
ActionGroupingBehavior (Required) selectionBehavior 0..1 code any | all | all-or-none | exactly-one | at-most-one | one-or-more
ActionSelectionBehavior (Required) requiredBehavior 0..1 code must | could | must-unless-documented
ActionRequiredBehavior (Required) precheckBehavior 0..1 code yes | no
ActionPrecheckBehavior (Required) cardinalityBehavior 0..1 code single | multiple
ActionCardinalityBehavior (Required) definition[x] 0..1 Description of the activity to be performed definitionCanonical canonical(ActivityDefinition | PlanDefinition | Questionnaire) definitionUri uri transform 0..1 canonical(StructureMap) Transform to apply the template dynamicValue 0..* BackboneElement Dynamic aspects of the definition
path 0..1 string The path to the element to be set dynamically expression 0..1 Expression An expression that provides the dynamic value for the customization action 0..* see action A sub-action
Documentation for this format
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Specialized.Definitional Artifacts"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 2
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "business"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "cds"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/PlanDefinition",
"version" : "4.0.1",
"name" : "PlanDefinition",
"status" : "draft",
"date" : "2019-11-01T09:29:23+11:00",
"publisher" : "Health Level Seven International (Clinical Decision Support)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/dss/index.cfm"
}]
}],
"description" : "This resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support the description of a broad range of clinical artifacts such as clinical decision support rules, order sets and protocols.",
"fhirVersion" : "4.0.1",
"mapping" : [{
"identity" : "workflow",
"uri" : "http://hl7.org/fhir/workflow",
"name" : "Workflow Pattern"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/fivews",
"name" : "FiveWs Pattern Mapping"
},
{
"identity" : "objimpl",
"uri" : "http://hl7.org/fhir/object-implementation",
"name" : "Object Implementation Information"
},
{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
}],
"kind" : "resource",
"abstract" : false,
"type" : "PlanDefinition",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"_baseDefinition" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-codegen-super",
"valueString" : "MetadataResource"
}]
},
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "PlanDefinition",
"path" : "PlanDefinition",
"short" : "The definition of a plan for a series of actions, independent of any specific patient or context",
"definition" : "This resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support the description of a broad range of clinical artifacts such as clinical decision support rules, order sets and protocols.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "PlanDefinition",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "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",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.`div`.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "pdf-0",
"severity" : "warning",
"human" : "Name should be usable as an identifier for the module by machine processing applications such as code generation",
"expression" : "name.matches('[A-Z]([A-Za-z0-9_]){0,254}')",
"xpath" : "not(exists(f:name/@value)) or matches(f:name/@value, '[A-Z]([A-Za-z0-9_]){0,254}')"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "workflow",
"map" : "Definition"
}]
},
{
"id" : "PlanDefinition.id",
"path" : "PlanDefinition.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "PlanDefinition.meta",
"path" : "PlanDefinition.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "PlanDefinition.implicitRules",
"path" : "PlanDefinition.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "PlanDefinition.language",
"path" : "PlanDefinition.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "PlanDefinition.text",
"path" : "PlanDefinition.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "PlanDefinition.contained",
"path" : "PlanDefinition.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "PlanDefinition.extension",
"path" : "PlanDefinition.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "PlanDefinition.modifierExtension",
"path" : "PlanDefinition.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "PlanDefinition.url",
"path" : "PlanDefinition.url",
"short" : "Canonical identifier for this plan definition, represented as a URI (globally unique)",
"definition" : "An absolute URI that is used to identify this plan definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this plan definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the plan definition is stored on different servers.",
"comment" : "Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.\n\nThe determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions). \n\nIn some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.",
"requirements" : "Allows the plan definition to be referenced by a single globally unique identifier.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "PlanDefinition.url",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.url"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
}]
},
{
"id" : "PlanDefinition.identifier",
"path" : "PlanDefinition.identifier",
"short" : "Additional identifier for the plan definition",
"definition" : "A formal identifier that is used to identify this plan definition when it is represented in other formats, or referenced in a specification, model, design or an instance.",
"comment" : "Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this plan definition outside of FHIR, where it is not possible to use the logical URI.",
"requirements" : "Allows externally provided and/or usable business identifiers to be easily associated with the module.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "PlanDefinition.identifier",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Identifier"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.identifier"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "PlanDefinition.version",
"path" : "PlanDefinition.version",
"short" : "Business version of the plan definition",
"definition" : "The identifier that is used to identify this version of the plan definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the plan definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts.",
"comment" : "There may be different plan definition instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the plan definition with the format [url]|[version].",
"min" : 0,
"max" : "1",
"base" : {
"path" : "PlanDefinition.version",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.version"
},
{
"identity" : "w5",
"map" : "FiveWs.version"
}]
},
{
"id" : "PlanDefinition.name",
"path" : "PlanDefinition.name",
"short" : "Name for this plan definition (computer friendly)",
"definition" : "A natural language name identifying the plan definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.",
"comment" : "The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.",
"requirements" : "Support human navigation and code generation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "PlanDefinition.name",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"condition" : ["inv-0"],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "PlanDefinition.title",
"path" : "PlanDefinition.title",
"short" : "Name for this plan definition (human friendly)",
"definition" : "A short, descriptive, user-friendly title for the plan definition.",
"comment" : "This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "PlanDefinition.title",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.title"
}]
},
{
"id" : "PlanDefinition.subtitle",
"path" : "PlanDefinition.subtitle",
"short" : "Subordinate title of the plan definition",
"definition" : "An explanatory or alternate title for the plan definition giving additional information about its content.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "PlanDefinition.subtitle",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "PlanDefinition.type",
"path" : "PlanDefinition.type",
"short" : "order-set | clinical-protocol | eca-rule | workflow-definition",
"definition" : "A high-level category for the plan definition that distinguishes the kinds of systems that would be interested in the plan definition.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "PlanDefinition.type",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "PlanDefinitionType"
}],
"strength" : "extensible",
"description" : "The type of PlanDefinition.",
"valueSet" : "http://hl7.org/fhir/ValueSet/plan-definition-type"
}
},
{
"id" : "PlanDefinition.status",
"path" : "PlanDefinition.status",
"short" : "draft | active | retired | unknown",
"definition" : "The status of this plan definition. Enables tracking the life-cycle of the content.",
"comment" : "Allows filtering of plan definitions that are appropriate for use versus not.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "PlanDefinition.status",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This is labeled as \"Is Modifier\" because applications should not use a retired {{title}} without due consideration",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "PublicationStatus"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "The lifecycle status of an artifact.",
"valueSet" : "http://hl7.org/fhir/ValueSet/publication-status|4.0.1"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.status {different ValueSet}"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
}]
},
{
"id" : "PlanDefinition.experimental",
"path" : "PlanDefinition.experimental",
"short" : "For testing purposes, not real usage",
"definition" : "A Boolean value to indicate that this plan definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.",
"comment" : "Allows filtering of plan definitions that are appropriate for use versus not.",
"requirements" : "Enables experimental content to be developed following the same lifecycle that would be used for a production-level plan definition.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "PlanDefinition.experimental",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.experimental"
},
{
"identity" : "w5",
"map" : "FiveWs.class"
}]
},
{
"id" : "PlanDefinition.subject[x]",
"path" : "PlanDefinition.subject[x]",
"short" : "Type of individual the plan definition is focused on",
"definition" : "A code or group definition that describes the intended subject of the plan definition.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "PlanDefinition.subject[x]",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
},
{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Group"]
}],
"meaningWhenMissing" : "Patient",
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SubjectType"
}],
"strength" : "extensible",
"description" : "The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).",
"valueSet" : "http://hl7.org/fhir/ValueSet/subject-type"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.subject"
}]
},
{
"id" : "PlanDefinition.date",
"path" : "PlanDefinition.date",
"short" : "Date last changed",
"definition" : "The date (and optionally time) when the plan definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the plan definition changes.",
"comment" : "Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the plan definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.",
"alias" : ["Revision Date"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "PlanDefinition.date",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.date"
},
{
"identity" : "w5",
"map" : "FiveWs.recorded"
}]
},
{
"id" : "PlanDefinition.publisher",
"path" : "PlanDefinition.publisher",
"short" : "Name of the publisher (organization or individual)",
"definition" : "The name of the organization or individual that published the plan definition.",
"comment" : "Usually an organization but may be an individual. The publisher (or steward) of the plan definition is the organization or individual primarily responsible for the maintenance and upkeep of the plan definition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the plan definition. This item SHOULD be populated unless the information is available from context.",
"requirements" : "Helps establish the \"authority/credibility\" of the plan definition. May also allow for contact.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "PlanDefinition.publisher",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.publisher"
},
{
"identity" : "w5",
"map" : "FiveWs.witness"
}]
},
{
"id" : "PlanDefinition.contact",
"path" : "PlanDefinition.contact",
"short" : "Contact details for the publisher",
"definition" : "Contact details to assist a user in finding and communicating with the publisher.",
"comment" : "May be a web site, an email address, a telephone number, etc.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "PlanDefinition.contact",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "ContactDetail"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.contact"
}]
},
{
"id" : "PlanDefinition.description",
"path" : "PlanDefinition.description",
"short" : "Natural language description of the plan definition",
"definition" : "A free text natural language description of the plan definition from a consumer's perspective.",
"comment" : "This description can be used to capture details such as why the plan definition was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the plan definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the plan definition is presumed to be the predominant language in the place the plan definition was created).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "PlanDefinition.description",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "markdown"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.description"
}]
},
{
"id" : "PlanDefinition.useContext",
"path" : "PlanDefinition.useContext",
"short" : "The context that the content is intended to support",
"definition" : "The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate plan definition instances.",
"comment" : "When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.",
"requirements" : "Assist in searching for appropriate content.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "PlanDefinition.useContext",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "UsageContext"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.useContext"
}]
},
{
"id" : "PlanDefinition.jurisdiction",
"path" : "PlanDefinition.jurisdiction",
"short" : "Intended jurisdiction for plan definition (if applicable)",
"definition" : "A legal or geographic region in which the plan definition is intended to be used.",
"comment" : "It may be possible for the plan definition to be used in jurisdictions other than those for which it was originally designed or intended.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "PlanDefinition.jurisdiction",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Jurisdiction"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "extensible",
"description" : "Countries and regions within which this artifact is targeted for use.",
"valueSet" : "http://hl7.org/fhir/ValueSet/jurisdiction"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.jurisdiction"
}]
},
{
"id" : "PlanDefinition.purpose",
"path" : "PlanDefinition.purpose",
"short" : "Why this plan definition is defined",
"definition" : "Explanation of why this plan definition is needed and why it has been designed as it has.",
"comment" : "This element does not describe the usage of the plan definition. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this plan definition.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "PlanDefinition.purpose",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "markdown"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.purpose"
},
{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "PlanDefinition.usage",
"path" : "PlanDefinition.usage",
"short" : "Describes the clinical usage of the plan",
"definition" : "A detailed description of how the plan definition is used from a clinical perspective.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "PlanDefinition.usage",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "PlanDefinition.copyright",
"path" : "PlanDefinition.copyright",
"short" : "Use and/or publishing restrictions",
"definition" : "A copyright statement relating to the plan definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the plan definition.",
"requirements" : "Consumers must be able to determine any legal restrictions on the use of the plan definition and/or its content.",
"alias" : ["License",
"Restrictions"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "PlanDefinition.copyright",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "markdown"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.copyright"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "PlanDefinition.approvalDate",
"path" : "PlanDefinition.approvalDate",
"short" : "When the plan definition was approved by publisher",
"definition" : "The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.",
"comment" : "The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "PlanDefinition.approvalDate",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "date"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.approvalDate"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "PlanDefinition.lastReviewDate",
"path" : "PlanDefinition.lastReviewDate",
"short" : "When the plan definition was last reviewed",
"definition" : "The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.",
"comment" : "If specified, this date follows the original approval date.",
"requirements" : "Gives a sense of how \"current\" the content is. Resources that have not been reviewed in a long time may have a risk of being less appropriate/relevant.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "PlanDefinition.lastReviewDate",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "date"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.lastReviewDate"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "PlanDefinition.effectivePeriod",
"path" : "PlanDefinition.effectivePeriod",
"short" : "When the plan definition is expected to be used",
"definition" : "The period during which the plan definition content was or is planned to be in active use.",
"comment" : "The effective period for a plan definition determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 might be published in 2015.",
"requirements" : "Allows establishing a transition before a resource comes into effect and also allows for a sunsetting process when new versions of the plan definition are or are expected to be used instead.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "PlanDefinition.effectivePeriod",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Period"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.effectivePeriod"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "PlanDefinition.topic",
"path" : "PlanDefinition.topic",
"short" : "E.g. Education, Treatment, Assessment",
"definition" : "Descriptive topics related to the content of the plan definition. Topics provide a high-level categorization of the definition that can be useful for filtering and searching.",
"requirements" : "Repositories must be able to determine how to categorize the plan definition so that it can be found by topical searches.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "PlanDefinition.topic",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "DefinitionTopic"
}],
"strength" : "example",
"description" : "High-level categorization of the definition, used for searching, sorting, and filtering.",
"valueSet" : "http://hl7.org/fhir/ValueSet/definition-topic"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.subject[x]"
}]
},
{
"id" : "PlanDefinition.author",
"path" : "PlanDefinition.author",
"short" : "Who authored the content",
"definition" : "An individiual or organization primarily involved in the creation and maintenance of the content.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "PlanDefinition.author",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "ContactDetail"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".participation[typeCode=AUT]"
}]
},
{
"id" : "PlanDefinition.editor",
"path" : "PlanDefinition.editor",
"short" : "Who edited the content",
"definition" : "An individual or organization primarily responsible for internal coherence of the content.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "PlanDefinition.editor",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "ContactDetail"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "PlanDefinition.reviewer",
"path" : "PlanDefinition.reviewer",
"short" : "Who reviewed the content",
"definition" : "An individual or organization primarily responsible for review of some aspect of the content.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "PlanDefinition.reviewer",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "ContactDetail"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".participation[typeCode=VRF] {not clear whether VRF best corresponds to reviewer or endorser}"
}]
},
{
"id" : "PlanDefinition.endorser",
"path" : "PlanDefinition.endorser",
"short" : "Who endorsed the content",
"definition" : "An individual or organization responsible for officially endorsing the content for use in some setting.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "PlanDefinition.endorser",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "ContactDetail"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".participation[typeCode=VRF] {not clear whether VRF best corresponds to reviewer or endorser}"
}]
},
{
"id" : "PlanDefinition.relatedArtifact",
"path" : "PlanDefinition.relatedArtifact",
"short" : "Additional documentation, citations",
"definition" : "Related artifacts such as additional documentation, justification, or bibliographic references.",
"comment" : "Each related artifact is either an attachment, or a reference to another resource, but not both.",
"requirements" : "Plan definitions must be able to provide enough information for consumers of the content (and/or interventions or results produced by the content) to be able to determine and understand the justification for and evidence in support of the content.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "PlanDefinition.relatedArtifact",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "RelatedArtifact"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "PlanDefinition.library",
"path" : "PlanDefinition.library",
"short" : "Logic used by the plan definition",
"definition" : "A reference to a Library resource containing any formal logic used by the plan definition.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "PlanDefinition.library",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Library"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "PlanDefinition.goal",
"path" : "PlanDefinition.goal",
"short" : "What the plan is trying to accomplish",
"definition" : "Goals that describe what the activities within the plan are intended to achieve. For example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, etc.",
"requirements" : "Goal information needs to be captured for order sets, protocols, and care plan definitions to better describe the objectives of the protocol activities and to guide the creation of specific goals within the derived care plans and orders.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "PlanDefinition.goal",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "PlanDefinition.goal.id",
"path" : "PlanDefinition.goal.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "PlanDefinition.goal.extension",
"path" : "PlanDefinition.goal.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "PlanDefinition.goal.modifierExtension",
"path" : "PlanDefinition.goal.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "PlanDefinition.goal.category",
"path" : "PlanDefinition.goal.category",
"short" : "E.g. Treatment, dietary, behavioral",
"definition" : "Indicates a category the goal falls within.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "PlanDefinition.goal.category",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "GoalCategory"
}],
"strength" : "example",
"description" : "Example codes for grouping goals for filtering or presentation.",
"valueSet" : "http://hl7.org/fhir/ValueSet/goal-category"
}
},
{
"id" : "PlanDefinition.goal.description",
"path" : "PlanDefinition.goal.description",
"short" : "Code or text describing the goal",
"definition" : "Human-readable and/or coded description of a specific desired objective of care, such as \"control blood pressure\" or \"negotiate an obstacle course\" or \"dance with child at wedding\".",
"comment" : "If no code is available, use CodeableConcept.text.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "PlanDefinition.goal.description",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "GoalDescription"
}],
"strength" : "example",
"description" : "Describes goals that can be achieved.",
"valueSet" : "http://hl7.org/fhir/ValueSet/clinical-findings"
}
},
{
"id" : "PlanDefinition.goal.priority",
"path" : "PlanDefinition.goal.priority",
"short" : "high-priority | medium-priority | low-priority",
"definition" : "Identifies the expected level of importance associated with reaching/sustaining the defined goal.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "PlanDefinition.goal.priority",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "GoalPriority"
}],
"strength" : "preferred",
"description" : "Indicates the level of importance associated with reaching or sustaining a goal.",
"valueSet" : "http://hl7.org/fhir/ValueSet/goal-priority"
}
},
{
"id" : "PlanDefinition.goal.start",
"path" : "PlanDefinition.goal.start",
"short" : "When goal pursuit begins",
"definition" : "The event after which the goal should begin being pursued.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "PlanDefinition.goal.start",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "GoalStartEvent"
}],
"strength" : "example",
"description" : "Identifies the types of events that might trigger the start of a goal.",
"valueSet" : "http://hl7.org/fhir/ValueSet/goal-start-event"
}
},
{
"id" : "PlanDefinition.goal.addresses",
"path" : "PlanDefinition.goal.addresses",
"short" : "What does the goal address",
"definition" : "Identifies problems, conditions, issues, or concerns the goal is intended to address.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "PlanDefinition.goal.addresses",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "GoalAddresses"
}],
"strength" : "example",
"description" : "Identifies problems, conditions, issues, or concerns that goals may address.",
"valueSet" : "http://hl7.org/fhir/ValueSet/condition-code"
}
},
{
"id" : "PlanDefinition.goal.documentation",
"path" : "PlanDefinition.goal.documentation",
"short" : "Supporting documentation for the goal",
"definition" : "Didactic or other informational resources associated with the goal that provide further supporting information about the goal. Information resources can include inline text commentary and links to web resources.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "PlanDefinition.goal.documentation",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "RelatedArtifact"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "PlanDefinition.goal.target",
"path" : "PlanDefinition.goal.target",
"short" : "Target outcome for the goal",
"definition" : "Indicates what should be done and within what timeframe.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "PlanDefinition.goal.target",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "PlanDefinition.goal.target.id",
"path" : "PlanDefinition.goal.target.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "PlanDefinition.goal.target.extension",
"path" : "PlanDefinition.goal.target.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "PlanDefinition.goal.target.modifierExtension",
"path" : "PlanDefinition.goal.target.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "PlanDefinition.goal.target.measure",
"path" : "PlanDefinition.goal.target.measure",
"short" : "The parameter whose value is to be tracked",
"definition" : "The parameter whose value is to be tracked, e.g. body weight, blood pressure, or hemoglobin A1c level.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "PlanDefinition.goal.target.measure",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "GoalTargetMeasure"
}],
"strength" : "example",
"description" : "Identifies types of parameters that can be tracked to determine goal achievement.",
"valueSet" : "http://hl7.org/fhir/ValueSet/observation-codes"
}
},
{
"id" : "PlanDefinition.goal.target.detail[x]",
"path" : "PlanDefinition.goal.target.detail[x]",
"short" : "The target value to be achieved",
"definition" : "The target value of the measure to be achieved to signify fulfillment of the goal, e.g. 150 pounds or 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any value at or above the low value.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "PlanDefinition.goal.target.detail[x]",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Quantity"
},
{
"code" : "Range"
},
{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "PlanDefinition.goal.target.due",
"path" : "PlanDefinition.goal.target.due",
"short" : "Reach goal within",
"definition" : "Indicates the timeframe after the start of the goal in which the goal should be met.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "PlanDefinition.goal.target.due",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Duration"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "PlanDefinition.action",
"path" : "PlanDefinition.action",
"short" : "Action defined by the plan",
"definition" : "An action or group of actions to be taken as part of the plan.",
"comment" : "Note that there is overlap between many of the elements defined here and the ActivityDefinition resource. When an ActivityDefinition is referenced (using the definition element), the overlapping elements in the plan override the content of the referenced ActivityDefinition unless otherwise documented in the specific elements. See the PlanDefinition resource for more detailed information.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "PlanDefinition.action",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "{Is a contained Definition}"
}]
},
{
"id" : "PlanDefinition.action.id",
"path" : "PlanDefinition.action.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "PlanDefinition.action.extension",
"path" : "PlanDefinition.action.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "PlanDefinition.action.modifierExtension",
"path" : "PlanDefinition.action.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "PlanDefinition.action.prefix",
"path" : "PlanDefinition.action.prefix",
"short" : "User-visible prefix for the action (e.g. 1. or A.)",
"definition" : "A user-visible prefix for the action.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "PlanDefinition.action.prefix",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "PlanDefinition.action.title",
"path" : "PlanDefinition.action.title",
"short" : "User-visible title",
"definition" : "The title of the action displayed to a user.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "PlanDefinition.action.title",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.title"
}]
},
{
"id" : "PlanDefinition.action.description",
"path" : "PlanDefinition.action.description",
"short" : "Brief description of the action",
"definition" : "A brief description of the action used to provide a summary to display to the user.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "PlanDefinition.action.description",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.description"
}]
},
{
"id" : "PlanDefinition.action.textEquivalent",
"path" : "PlanDefinition.action.textEquivalent",
"short" : "Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system",
"definition" : "A text equivalent of the action to be performed. This provides a human-interpretable description of the action when the definition is consumed by a system that might not be capable of interpreting it dynamically.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "PlanDefinition.action.textEquivalent",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.description"
}]
},
{
"id" : "PlanDefinition.action.priority",
"path" : "PlanDefinition.action.priority",
"short" : "routine | urgent | asap | stat",
"definition" : "Indicates how quickly the action should be addressed with respect to other actions.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "PlanDefinition.action.priority",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "RequestPriority"
}],
"strength" : "required",
"description" : "Identifies the level of importance to be assigned to actioning the request.",
"valueSet" : "http://hl7.org/fhir/ValueSet/request-priority|4.0.1"
}
},
{
"id" : "PlanDefinition.action.code",
"path" : "PlanDefinition.action.code",
"short" : "Code representing the meaning of the action or sub-actions",
"definition" : "A code that provides meaning for the action or action group. For example, a section may have a LOINC code for the section of a documentation template.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "PlanDefinition.action.code",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "PlanDefinition.action.reason",
"path" : "PlanDefinition.action.reason",
"short" : "Why the action should be performed",
"definition" : "A description of why this action is necessary or appropriate.",
"comment" : "This is different than the clinical evidence documentation, it's an actual business description of the reason for performing the action.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "PlanDefinition.action.reason",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "PlanDefinition.action.documentation",
"path" : "PlanDefinition.action.documentation",
"short" : "Supporting documentation for the intended performer of the action",
"definition" : "Didactic or other informational resources associated with the action that can be provided to the CDS recipient. Information resources can include inline text commentary and links to web resources.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "PlanDefinition.action.documentation",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "RelatedArtifact"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "PlanDefinition.action.goalId",
"path" : "PlanDefinition.action.goalId",
"short" : "What goals this action supports",
"definition" : "Identifies goals that this action supports. The reference must be to a goal element defined within this plan definition.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "PlanDefinition.action.goalId",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "id"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "PlanDefinition.action.subject[x]",
"path" : "PlanDefinition.action.subject[x]",
"short" : "Type of individual the action is focused on",
"definition" : "A code or group definition that describes the intended subject of the action and its children, if any.",
"comment" : "The subject of an action overrides the subject at a parent action or on the root of the PlanDefinition if specified.\n\nIn addition, because the subject needs to be resolved during realization, use of subjects in actions (or in the ActivityDefinition referenced by the action) resolves based on the set of subjects supplied in context and by type (i.e. the patient subject would resolve to a resource of type Patient).",
"requirements" : "Multiple steps in a protocol often have different groups of steps that are focused on testing different things. The subject of an action specifies the focus of the action and any child actions.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "PlanDefinition.action.subject[x]",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
},
{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Group"]
}],
"meaningWhenMissing" : "Patient",
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SubjectType"
}],
"strength" : "extensible",
"description" : "The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).",
"valueSet" : "http://hl7.org/fhir/ValueSet/subject-type"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.subject"
}]
},
{
"id" : "PlanDefinition.action.trigger",
"path" : "PlanDefinition.action.trigger",
"short" : "When the action should be triggered",
"definition" : "A description of when the action should be triggered.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "PlanDefinition.action.trigger",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "TriggerDefinition"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "PlanDefinition.action.condition",
"path" : "PlanDefinition.action.condition",
"short" : "Whether or not the action is applicable",
"definition" : "An expression that describes applicability criteria or start/stop conditions for the action.",
"comment" : "When multiple conditions of the same kind are present, the effects are combined using AND semantics, so the overall condition is true only if all the conditions are true.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "PlanDefinition.action.condition",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "PlanDefinition.action.condition.id",
"path" : "PlanDefinition.action.condition.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "PlanDefinition.action.condition.extension",
"path" : "PlanDefinition.action.condition.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "PlanDefinition.action.condition.modifierExtension",
"path" : "PlanDefinition.action.condition.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "PlanDefinition.action.condition.kind",
"path" : "PlanDefinition.action.condition.kind",
"short" : "applicability | start | stop",
"definition" : "The kind of condition.",
"comment" : "Applicability criteria are used to determine immediate applicability when a plan definition is applied to a given context. Start and stop criteria are carried through application and used to describe enter/exit criteria for an action.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "PlanDefinition.action.condition.kind",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ActionConditionKind"
}],
"strength" : "required",
"description" : "Defines the kinds of conditions that can appear on actions.",
"valueSet" : "http://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1"
}
},
{
"id" : "PlanDefinition.action.condition.expression",
"path" : "PlanDefinition.action.condition.expression",
"short" : "Boolean-valued expression",
"definition" : "An expression that returns true or false, indicating whether the condition is satisfied.",
"comment" : "The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "PlanDefinition.action.condition.expression",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Expression"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "PlanDefinition.action.input",
"path" : "PlanDefinition.action.input",
"short" : "Input data requirements",
"definition" : "Defines input data requirements for the action.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "PlanDefinition.action.input",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "DataRequirement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "PlanDefinition.action.output",
"path" : "PlanDefinition.action.output",
"short" : "Output data definition",
"definition" : "Defines the outputs of the action, if any.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "PlanDefinition.action.output",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "DataRequirement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "PlanDefinition.action.relatedAction",
"path" : "PlanDefinition.action.relatedAction",
"short" : "Relationship to another action",
"definition" : "A relationship to another action such as \"before\" or \"30-60 minutes after start of\".",
"comment" : "When an action depends on multiple actions, the meaning is that all actions are dependencies, rather than that any of the actions are a dependency.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "PlanDefinition.action.relatedAction",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "PlanDefinition.action.relatedAction.id",
"path" : "PlanDefinition.action.relatedAction.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "PlanDefinition.action.relatedAction.extension",
"path" : "PlanDefinition.action.relatedAction.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "PlanDefinition.action.relatedAction.modifierExtension",
"path" : "PlanDefinition.action.relatedAction.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "PlanDefinition.action.relatedAction.actionId",
"path" : "PlanDefinition.action.relatedAction.actionId",
"short" : "What action is this related to",
"definition" : "The element id of the related action.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "PlanDefinition.action.relatedAction.actionId",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "id"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "PlanDefinition.action.relatedAction.relationship",
"path" : "PlanDefinition.action.relatedAction.relationship",
"short" : "before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end",
"definition" : "The relationship of this action to the related action.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "PlanDefinition.action.relatedAction.relationship",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ActionRelationshipType"
}],
"strength" : "required",
"description" : "Defines the types of relationships between actions.",
"valueSet" : "http://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1"
}
},
{
"id" : "PlanDefinition.action.relatedAction.offset[x]",
"path" : "PlanDefinition.action.relatedAction.offset[x]",
"short" : "Time offset for the relationship",
"definition" : "A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "PlanDefinition.action.relatedAction.offset[x]",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Duration"
},
{
"code" : "Range"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "PlanDefinition.action.timing[x]",
"path" : "PlanDefinition.action.timing[x]",
"short" : "When the action should take place",
"definition" : "An optional value describing when the action should be performed.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "PlanDefinition.action.timing[x]",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
},
{
"code" : "Age"
},
{
"code" : "Period"
},
{
"code" : "Duration"
},
{
"code" : "Range"
},
{
"code" : "Timing"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "PlanDefinition.action.participant",
"path" : "PlanDefinition.action.participant",
"short" : "Who should participate in the action",
"definition" : "Indicates who should participate in performing the action described.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "PlanDefinition.action.participant",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "PlanDefinition.action.participant.id",
"path" : "PlanDefinition.action.participant.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "PlanDefinition.action.participant.extension",
"path" : "PlanDefinition.action.participant.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "PlanDefinition.action.participant.modifierExtension",
"path" : "PlanDefinition.action.participant.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "PlanDefinition.action.participant.type",
"path" : "PlanDefinition.action.participant.type",
"short" : "patient | practitioner | related-person | device",
"definition" : "The type of participant in the action.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "PlanDefinition.action.participant.type",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ActionParticipantType"
}],
"strength" : "required",
"description" : "The type of participant for the action.",
"valueSet" : "http://hl7.org/fhir/ValueSet/action-participant-type|4.0.1"
}
},
{
"id" : "PlanDefinition.action.participant.role",
"path" : "PlanDefinition.action.participant.role",
"short" : "E.g. Nurse, Surgeon, Parent",
"definition" : "The role the participant should play in performing the described action.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "PlanDefinition.action.participant.role",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ActionParticipantRole"
}],
"strength" : "example",
"description" : "Defines roles played by participants for the action.",
"valueSet" : "http://hl7.org/fhir/ValueSet/action-participant-role"
}
},
{
"id" : "PlanDefinition.action.type",
"path" : "PlanDefinition.action.type",
"short" : "create | update | remove | fire-event",
"definition" : "The type of action to perform (create, update, remove).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "PlanDefinition.action.type",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ActionType"
}],
"strength" : "extensible",
"description" : "The type of action to be performed.",
"valueSet" : "http://hl7.org/fhir/ValueSet/action-type"
}
},
{
"id" : "PlanDefinition.action.groupingBehavior",
"path" : "PlanDefinition.action.groupingBehavior",
"short" : "visual-group | logical-group | sentence-group",
"definition" : "Defines the grouping behavior for the action and its children.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "PlanDefinition.action.groupingBehavior",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ActionGroupingBehavior"
}],
"strength" : "required",
"description" : "Defines organization behavior of a group.",
"valueSet" : "http://hl7.org/fhir/ValueSet/action-grouping-behavior|4.0.1"
}
},
{
"id" : "PlanDefinition.action.selectionBehavior",
"path" : "PlanDefinition.action.selectionBehavior",
"short" : "any | all | all-or-none | exactly-one | at-most-one | one-or-more",
"definition" : "Defines the selection behavior for the action and its children.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "PlanDefinition.action.selectionBehavior",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ActionSelectionBehavior"
}],
"strength" : "required",
"description" : "Defines selection behavior of a group.",
"valueSet" : "http://hl7.org/fhir/ValueSet/action-selection-behavior|4.0.1"
}
},
{
"id" : "PlanDefinition.action.requiredBehavior",
"path" : "PlanDefinition.action.requiredBehavior",
"short" : "must | could | must-unless-documented",
"definition" : "Defines the required behavior for the action.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "PlanDefinition.action.requiredBehavior",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ActionRequiredBehavior"
}],
"strength" : "required",
"description" : "Defines expectations around whether an action or action group is required.",
"valueSet" : "http://hl7.org/fhir/ValueSet/action-required-behavior|4.0.1"
}
},
{
"id" : "PlanDefinition.action.precheckBehavior",
"path" : "PlanDefinition.action.precheckBehavior",
"short" : "yes | no",
"definition" : "Defines whether the action should usually be preselected.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "PlanDefinition.action.precheckBehavior",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ActionPrecheckBehavior"
}],
"strength" : "required",
"description" : "Defines selection frequency behavior for an action or group.",
"valueSet" : "http://hl7.org/fhir/ValueSet/action-precheck-behavior|4.0.1"
}
},
{
"id" : "PlanDefinition.action.cardinalityBehavior",
"path" : "PlanDefinition.action.cardinalityBehavior",
"short" : "single | multiple",
"definition" : "Defines whether the action can be selected multiple times.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "PlanDefinition.action.cardinalityBehavior",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ActionCardinalityBehavior"
}],
"strength" : "required",
"description" : "Defines behavior for an action or a group for how many times that item may be repeated.",
"valueSet" : "http://hl7.org/fhir/ValueSet/action-cardinality-behavior|4.0.1"
}
},
{
"id" : "PlanDefinition.action.definition[x]",
"path" : "PlanDefinition.action.definition[x]",
"short" : "Description of the activity to be performed",
"definition" : "A reference to an ActivityDefinition that describes the action to be taken in detail, or a PlanDefinition that describes a series of actions to be taken.",
"comment" : "Note that the definition is optional, and if no definition is specified, a dynamicValue with a root ($this) path can be used to define the entire resource dynamically.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "PlanDefinition.action.definition[x]",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ActivityDefinition",
"http://hl7.org/fhir/StructureDefinition/PlanDefinition",
"http://hl7.org/fhir/StructureDefinition/Questionnaire"]
},
{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.derivedFrom"
}]
},
{
"id" : "PlanDefinition.action.transform",
"path" : "PlanDefinition.action.transform",
"short" : "Transform to apply the template",
"definition" : "A reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the input.",
"comment" : "Note that when a referenced ActivityDefinition also defines a transform, the transform specified here generally takes precedence. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "PlanDefinition.action.transform",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/StructureMap"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "PlanDefinition.action.dynamicValue",
"path" : "PlanDefinition.action.dynamicValue",
"short" : "Dynamic aspects of the definition",
"definition" : "Customizations that should be applied to the statically defined resource. For example, if the dosage of a medication must be computed based on the patient's weight, a customization would be used to specify an expression that calculated the weight, and the path on the resource that would contain the result.",
"comment" : "Dynamic values are applied in the order in which they are defined in the PlanDefinition resource. Note that when dynamic values are also specified by a referenced ActivityDefinition, the dynamicValues from the ActivityDefinition are applied first, followed by the dynamicValues specified here. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "PlanDefinition.action.dynamicValue",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "PlanDefinition.action.dynamicValue.id",
"path" : "PlanDefinition.action.dynamicValue.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "PlanDefinition.action.dynamicValue.extension",
"path" : "PlanDefinition.action.dynamicValue.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "PlanDefinition.action.dynamicValue.modifierExtension",
"path" : "PlanDefinition.action.dynamicValue.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "PlanDefinition.action.dynamicValue.path",
"path" : "PlanDefinition.action.dynamicValue.path",
"short" : "The path to the element to be set dynamically",
"definition" : "The path to the element to be customized. This is the path on the resource that will hold the result of the calculation defined by the expression. The specified path SHALL be a FHIRPath resolveable on the specified target type of the ActivityDefinition, and SHALL consist only of identifiers, constant indexers, and a restricted subset of functions. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the [Simple FHIRPath Profile](fhirpath.html#simple) for full details).",
"comment" : "To specify the path to the current action being realized, the %action environment variable is available in this path. For example, to specify the description element of the target action, the path would be %action.description. The path attribute contains a [Simple FHIRPath Subset](fhirpath.html#simple) that allows path traversal, but not calculation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "PlanDefinition.action.dynamicValue.path",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "PlanDefinition.action.dynamicValue.expression",
"path" : "PlanDefinition.action.dynamicValue.expression",
"short" : "An expression that provides the dynamic value for the customization",
"definition" : "An expression specifying the value of the customized element.",
"comment" : "The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "PlanDefinition.action.dynamicValue.expression",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Expression"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "PlanDefinition.action.action",
"path" : "PlanDefinition.action.action",
"short" : "A sub-action",
"definition" : "Sub actions that are contained within the action. The behavior of this action determines the functionality of the sub-actions. For example, a selection behavior of at-most-one indicates that of the sub-actions, at most one may be chosen as part of realizing the action definition.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "PlanDefinition.action.action",
"min" : 0,
"max" : "*"
},
"contentReference" : "#PlanDefinition.action",
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "{InverseRelationship of Definition.partOf}"
}]
}]
},
"differential" : {
"element" : [{
"id" : "PlanDefinition",
"path" : "PlanDefinition",
"short" : "The definition of a plan for a series of actions, independent of any specific patient or context",
"definition" : "This resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support the description of a broad range of clinical artifacts such as clinical decision support rules, order sets and protocols.",
"min" : 0,
"max" : "*",
"constraint" : [{
"key" : "pdf-0",
"severity" : "warning",
"human" : "Name should be usable as an identifier for the module by machine processing applications such as code generation",
"expression" : "name.matches('[A-Z]([A-Za-z0-9_]){0,254}')",
"xpath" : "not(exists(f:name/@value)) or matches(f:name/@value, '[A-Z]([A-Za-z0-9_]){0,254}')"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Definition"
}]
},
{
"id" : "PlanDefinition.url",
"path" : "PlanDefinition.url",
"short" : "Canonical identifier for this plan definition, represented as a URI (globally unique)",
"definition" : "An absolute URI that is used to identify this plan definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this plan definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the plan definition is stored on different servers.",
"comment" : "Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.\n\nThe determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions). \n\nIn some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.",
"requirements" : "Allows the plan definition to be referenced by a single globally unique identifier.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "uri"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.url"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
}]
},
{
"id" : "PlanDefinition.identifier",
"path" : "PlanDefinition.identifier",
"short" : "Additional identifier for the plan definition",
"definition" : "A formal identifier that is used to identify this plan definition when it is represented in other formats, or referenced in a specification, model, design or an instance.",
"comment" : "Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this plan definition outside of FHIR, where it is not possible to use the logical URI.",
"requirements" : "Allows externally provided and/or usable business identifiers to be easily associated with the module.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Identifier"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.identifier"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "PlanDefinition.version",
"path" : "PlanDefinition.version",
"short" : "Business version of the plan definition",
"definition" : "The identifier that is used to identify this version of the plan definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the plan definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts.",
"comment" : "There may be different plan definition instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the plan definition with the format [url]|[version].",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.version"
},
{
"identity" : "w5",
"map" : "FiveWs.version"
}]
},
{
"id" : "PlanDefinition.name",
"path" : "PlanDefinition.name",
"short" : "Name for this plan definition (computer friendly)",
"definition" : "A natural language name identifying the plan definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.",
"comment" : "The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.",
"requirements" : "Support human navigation and code generation.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"condition" : ["inv-0"],
"isSummary" : true
},
{
"id" : "PlanDefinition.title",
"path" : "PlanDefinition.title",
"short" : "Name for this plan definition (human friendly)",
"definition" : "A short, descriptive, user-friendly title for the plan definition.",
"comment" : "This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.title"
}]
},
{
"id" : "PlanDefinition.subtitle",
"path" : "PlanDefinition.subtitle",
"short" : "Subordinate title of the plan definition",
"definition" : "An explanatory or alternate title for the plan definition giving additional information about its content.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}]
},
{
"id" : "PlanDefinition.type",
"path" : "PlanDefinition.type",
"short" : "order-set | clinical-protocol | eca-rule | workflow-definition",
"definition" : "A high-level category for the plan definition that distinguishes the kinds of systems that would be interested in the plan definition.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "PlanDefinitionType"
}],
"strength" : "extensible",
"description" : "The type of PlanDefinition.",
"valueSet" : "http://hl7.org/fhir/ValueSet/plan-definition-type"
}
},
{
"id" : "PlanDefinition.status",
"path" : "PlanDefinition.status",
"short" : "draft | active | retired | unknown",
"definition" : "The status of this plan definition. Enables tracking the life-cycle of the content.",
"comment" : "Allows filtering of plan definitions that are appropriate for use versus not.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isModifier" : true,
"isModifierReason" : "This is labeled as \"Is Modifier\" because applications should not use a retired {{title}} without due consideration",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "PublicationStatus"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "The lifecycle status of an artifact.",
"valueSet" : "http://hl7.org/fhir/ValueSet/publication-status|4.0.1"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.status {different ValueSet}"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
}]
},
{
"id" : "PlanDefinition.experimental",
"path" : "PlanDefinition.experimental",
"short" : "For testing purposes, not real usage",
"definition" : "A Boolean value to indicate that this plan definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.",
"comment" : "Allows filtering of plan definitions that are appropriate for use versus not.",
"requirements" : "Enables experimental content to be developed following the same lifecycle that would be used for a production-level plan definition.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "boolean"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.experimental"
},
{
"identity" : "w5",
"map" : "FiveWs.class"
}]
},
{
"id" : "PlanDefinition.subject[x]",
"path" : "PlanDefinition.subject[x]",
"short" : "Type of individual the plan definition is focused on",
"definition" : "A code or group definition that describes the intended subject of the plan definition.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
},
{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Group"]
}],
"meaningWhenMissing" : "Patient",
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SubjectType"
}],
"strength" : "extensible",
"description" : "The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).",
"valueSet" : "http://hl7.org/fhir/ValueSet/subject-type"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.subject"
}]
},
{
"id" : "PlanDefinition.date",
"path" : "PlanDefinition.date",
"short" : "Date last changed",
"definition" : "The date (and optionally time) when the plan definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the plan definition changes.",
"comment" : "Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the plan definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.",
"alias" : ["Revision Date"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "dateTime"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.date"
},
{
"identity" : "w5",
"map" : "FiveWs.recorded"
}]
},
{
"id" : "PlanDefinition.publisher",
"path" : "PlanDefinition.publisher",
"short" : "Name of the publisher (organization or individual)",
"definition" : "The name of the organization or individual that published the plan definition.",
"comment" : "Usually an organization but may be an individual. The publisher (or steward) of the plan definition is the organization or individual primarily responsible for the maintenance and upkeep of the plan definition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the plan definition. This item SHOULD be populated unless the information is available from context.",
"requirements" : "Helps establish the \"authority/credibility\" of the plan definition. May also allow for contact.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.publisher"
},
{
"identity" : "w5",
"map" : "FiveWs.witness"
}]
},
{
"id" : "PlanDefinition.contact",
"path" : "PlanDefinition.contact",
"short" : "Contact details for the publisher",
"definition" : "Contact details to assist a user in finding and communicating with the publisher.",
"comment" : "May be a web site, an email address, a telephone number, etc.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "ContactDetail"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.contact"
}]
},
{
"id" : "PlanDefinition.description",
"path" : "PlanDefinition.description",
"short" : "Natural language description of the plan definition",
"definition" : "A free text natural language description of the plan definition from a consumer's perspective.",
"comment" : "This description can be used to capture details such as why the plan definition was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the plan definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the plan definition is presumed to be the predominant language in the place the plan definition was created).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "markdown"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.description"
}]
},
{
"id" : "PlanDefinition.useContext",
"path" : "PlanDefinition.useContext",
"short" : "The context that the content is intended to support",
"definition" : "The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate plan definition instances.",
"comment" : "When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.",
"requirements" : "Assist in searching for appropriate content.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "UsageContext"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.useContext"
}]
},
{
"id" : "PlanDefinition.jurisdiction",
"path" : "PlanDefinition.jurisdiction",
"short" : "Intended jurisdiction for plan definition (if applicable)",
"definition" : "A legal or geographic region in which the plan definition is intended to be used.",
"comment" : "It may be possible for the plan definition to be used in jurisdictions other than those for which it was originally designed or intended.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Jurisdiction"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "extensible",
"description" : "Countries and regions within which this artifact is targeted for use.",
"valueSet" : "http://hl7.org/fhir/ValueSet/jurisdiction"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.jurisdiction"
}]
},
{
"id" : "PlanDefinition.purpose",
"path" : "PlanDefinition.purpose",
"short" : "Why this plan definition is defined",
"definition" : "Explanation of why this plan definition is needed and why it has been designed as it has.",
"comment" : "This element does not describe the usage of the plan definition. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this plan definition.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "markdown"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.purpose"
},
{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "PlanDefinition.usage",
"path" : "PlanDefinition.usage",
"short" : "Describes the clinical usage of the plan",
"definition" : "A detailed description of how the plan definition is used from a clinical perspective.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}]
},
{
"id" : "PlanDefinition.copyright",
"path" : "PlanDefinition.copyright",
"short" : "Use and/or publishing restrictions",
"definition" : "A copyright statement relating to the plan definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the plan definition.",
"requirements" : "Consumers must be able to determine any legal restrictions on the use of the plan definition and/or its content.",
"alias" : ["License",
"Restrictions"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "markdown"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.copyright"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "PlanDefinition.approvalDate",
"path" : "PlanDefinition.approvalDate",
"short" : "When the plan definition was approved by publisher",
"definition" : "The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.",
"comment" : "The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "date"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.approvalDate"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "PlanDefinition.lastReviewDate",
"path" : "PlanDefinition.lastReviewDate",
"short" : "When the plan definition was last reviewed",
"definition" : "The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.",
"comment" : "If specified, this date follows the original approval date.",
"requirements" : "Gives a sense of how \"current\" the content is. Resources that have not been reviewed in a long time may have a risk of being less appropriate/relevant.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "date"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.lastReviewDate"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "PlanDefinition.effectivePeriod",
"path" : "PlanDefinition.effectivePeriod",
"short" : "When the plan definition is expected to be used",
"definition" : "The period during which the plan definition content was or is planned to be in active use.",
"comment" : "The effective period for a plan definition determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 might be published in 2015.",
"requirements" : "Allows establishing a transition before a resource comes into effect and also allows for a sunsetting process when new versions of the plan definition are or are expected to be used instead.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Period"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.effectivePeriod"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "PlanDefinition.topic",
"path" : "PlanDefinition.topic",
"short" : "E.g. Education, Treatment, Assessment",
"definition" : "Descriptive topics related to the content of the plan definition. Topics provide a high-level categorization of the definition that can be useful for filtering and searching.",
"requirements" : "Repositories must be able to determine how to categorize the plan definition so that it can be found by topical searches.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "DefinitionTopic"
}],
"strength" : "example",
"description" : "High-level categorization of the definition, used for searching, sorting, and filtering.",
"valueSet" : "http://hl7.org/fhir/ValueSet/definition-topic"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.subject[x]"
}]
},
{
"id" : "PlanDefinition.author",
"path" : "PlanDefinition.author",
"short" : "Who authored the content",
"definition" : "An individiual or organization primarily involved in the creation and maintenance of the content.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "ContactDetail"
}],
"mapping" : [{
"identity" : "rim",
"map" : ".participation[typeCode=AUT]"
}]
},
{
"id" : "PlanDefinition.editor",
"path" : "PlanDefinition.editor",
"short" : "Who edited the content",
"definition" : "An individual or organization primarily responsible for internal coherence of the content.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "ContactDetail"
}]
},
{
"id" : "PlanDefinition.reviewer",
"path" : "PlanDefinition.reviewer",
"short" : "Who reviewed the content",
"definition" : "An individual or organization primarily responsible for review of some aspect of the content.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "ContactDetail"
}],
"mapping" : [{
"identity" : "rim",
"map" : ".participation[typeCode=VRF] {not clear whether VRF best corresponds to reviewer or endorser}"
}]
},
{
"id" : "PlanDefinition.endorser",
"path" : "PlanDefinition.endorser",
"short" : "Who endorsed the content",
"definition" : "An individual or organization responsible for officially endorsing the content for use in some setting.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "ContactDetail"
}],
"mapping" : [{
"identity" : "rim",
"map" : ".participation[typeCode=VRF] {not clear whether VRF best corresponds to reviewer or endorser}"
}]
},
{
"id" : "PlanDefinition.relatedArtifact",
"path" : "PlanDefinition.relatedArtifact",
"short" : "Additional documentation, citations",
"definition" : "Related artifacts such as additional documentation, justification, or bibliographic references.",
"comment" : "Each related artifact is either an attachment, or a reference to another resource, but not both.",
"requirements" : "Plan definitions must be able to provide enough information for consumers of the content (and/or interventions or results produced by the content) to be able to determine and understand the justification for and evidence in support of the content.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "RelatedArtifact"
}]
},
{
"id" : "PlanDefinition.library",
"path" : "PlanDefinition.library",
"short" : "Logic used by the plan definition",
"definition" : "A reference to a Library resource containing any formal logic used by the plan definition.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Library"]
}]
},
{
"id" : "PlanDefinition.goal",
"path" : "PlanDefinition.goal",
"short" : "What the plan is trying to accomplish",
"definition" : "Goals that describe what the activities within the plan are intended to achieve. For example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, etc.",
"requirements" : "Goal information needs to be captured for order sets, protocols, and care plan definitions to better describe the objectives of the protocol activities and to guide the creation of specific goals within the derived care plans and orders.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "PlanDefinition.goal.category",
"path" : "PlanDefinition.goal.category",
"short" : "E.g. Treatment, dietary, behavioral",
"definition" : "Indicates a category the goal falls within.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "GoalCategory"
}],
"strength" : "example",
"description" : "Example codes for grouping goals for filtering or presentation.",
"valueSet" : "http://hl7.org/fhir/ValueSet/goal-category"
}
},
{
"id" : "PlanDefinition.goal.description",
"path" : "PlanDefinition.goal.description",
"short" : "Code or text describing the goal",
"definition" : "Human-readable and/or coded description of a specific desired objective of care, such as \"control blood pressure\" or \"negotiate an obstacle course\" or \"dance with child at wedding\".",
"comment" : "If no code is available, use CodeableConcept.text.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "GoalDescription"
}],
"strength" : "example",
"description" : "Describes goals that can be achieved.",
"valueSet" : "http://hl7.org/fhir/ValueSet/clinical-findings"
}
},
{
"id" : "PlanDefinition.goal.priority",
"path" : "PlanDefinition.goal.priority",
"short" : "high-priority | medium-priority | low-priority",
"definition" : "Identifies the expected level of importance associated with reaching/sustaining the defined goal.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "GoalPriority"
}],
"strength" : "preferred",
"description" : "Indicates the level of importance associated with reaching or sustaining a goal.",
"valueSet" : "http://hl7.org/fhir/ValueSet/goal-priority"
}
},
{
"id" : "PlanDefinition.goal.start",
"path" : "PlanDefinition.goal.start",
"short" : "When goal pursuit begins",
"definition" : "The event after which the goal should begin being pursued.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "GoalStartEvent"
}],
"strength" : "example",
"description" : "Identifies the types of events that might trigger the start of a goal.",
"valueSet" : "http://hl7.org/fhir/ValueSet/goal-start-event"
}
},
{
"id" : "PlanDefinition.goal.addresses",
"path" : "PlanDefinition.goal.addresses",
"short" : "What does the goal address",
"definition" : "Identifies problems, conditions, issues, or concerns the goal is intended to address.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "GoalAddresses"
}],
"strength" : "example",
"description" : "Identifies problems, conditions, issues, or concerns that goals may address.",
"valueSet" : "http://hl7.org/fhir/ValueSet/condition-code"
}
},
{
"id" : "PlanDefinition.goal.documentation",
"path" : "PlanDefinition.goal.documentation",
"short" : "Supporting documentation for the goal",
"definition" : "Didactic or other informational resources associated with the goal that provide further supporting information about the goal. Information resources can include inline text commentary and links to web resources.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "RelatedArtifact"
}]
},
{
"id" : "PlanDefinition.goal.target",
"path" : "PlanDefinition.goal.target",
"short" : "Target outcome for the goal",
"definition" : "Indicates what should be done and within what timeframe.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "PlanDefinition.goal.target.measure",
"path" : "PlanDefinition.goal.target.measure",
"short" : "The parameter whose value is to be tracked",
"definition" : "The parameter whose value is to be tracked, e.g. body weight, blood pressure, or hemoglobin A1c level.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "GoalTargetMeasure"
}],
"strength" : "example",
"description" : "Identifies types of parameters that can be tracked to determine goal achievement.",
"valueSet" : "http://hl7.org/fhir/ValueSet/observation-codes"
}
},
{
"id" : "PlanDefinition.goal.target.detail[x]",
"path" : "PlanDefinition.goal.target.detail[x]",
"short" : "The target value to be achieved",
"definition" : "The target value of the measure to be achieved to signify fulfillment of the goal, e.g. 150 pounds or 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any value at or above the low value.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Quantity"
},
{
"code" : "Range"
},
{
"code" : "CodeableConcept"
}]
},
{
"id" : "PlanDefinition.goal.target.due",
"path" : "PlanDefinition.goal.target.due",
"short" : "Reach goal within",
"definition" : "Indicates the timeframe after the start of the goal in which the goal should be met.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Duration"
}]
},
{
"id" : "PlanDefinition.action",
"path" : "PlanDefinition.action",
"short" : "Action defined by the plan",
"definition" : "An action or group of actions to be taken as part of the plan.",
"comment" : "Note that there is overlap between many of the elements defined here and the ActivityDefinition resource. When an ActivityDefinition is referenced (using the definition element), the overlapping elements in the plan override the content of the referenced ActivityDefinition unless otherwise documented in the specific elements. See the PlanDefinition resource for more detailed information.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "{Is a contained Definition}"
}]
},
{
"id" : "PlanDefinition.action.prefix",
"path" : "PlanDefinition.action.prefix",
"short" : "User-visible prefix for the action (e.g. 1. or A.)",
"definition" : "A user-visible prefix for the action.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}]
},
{
"id" : "PlanDefinition.action.title",
"path" : "PlanDefinition.action.title",
"short" : "User-visible title",
"definition" : "The title of the action displayed to a user.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.title"
}]
},
{
"id" : "PlanDefinition.action.description",
"path" : "PlanDefinition.action.description",
"short" : "Brief description of the action",
"definition" : "A brief description of the action used to provide a summary to display to the user.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.description"
}]
},
{
"id" : "PlanDefinition.action.textEquivalent",
"path" : "PlanDefinition.action.textEquivalent",
"short" : "Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system",
"definition" : "A text equivalent of the action to be performed. This provides a human-interpretable description of the action when the definition is consumed by a system that might not be capable of interpreting it dynamically.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.description"
}]
},
{
"id" : "PlanDefinition.action.priority",
"path" : "PlanDefinition.action.priority",
"short" : "routine | urgent | asap | stat",
"definition" : "Indicates how quickly the action should be addressed with respect to other actions.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "code"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "RequestPriority"
}],
"strength" : "required",
"description" : "Identifies the level of importance to be assigned to actioning the request.",
"valueSet" : "http://hl7.org/fhir/ValueSet/request-priority|4.0.1"
}
},
{
"id" : "PlanDefinition.action.code",
"path" : "PlanDefinition.action.code",
"short" : "Code representing the meaning of the action or sub-actions",
"definition" : "A code that provides meaning for the action or action group. For example, a section may have a LOINC code for the section of a documentation template.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}]
},
{
"id" : "PlanDefinition.action.reason",
"path" : "PlanDefinition.action.reason",
"short" : "Why the action should be performed",
"definition" : "A description of why this action is necessary or appropriate.",
"comment" : "This is different than the clinical evidence documentation, it's an actual business description of the reason for performing the action.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}]
},
{
"id" : "PlanDefinition.action.documentation",
"path" : "PlanDefinition.action.documentation",
"short" : "Supporting documentation for the intended performer of the action",
"definition" : "Didactic or other informational resources associated with the action that can be provided to the CDS recipient. Information resources can include inline text commentary and links to web resources.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "RelatedArtifact"
}]
},
{
"id" : "PlanDefinition.action.goalId",
"path" : "PlanDefinition.action.goalId",
"short" : "What goals this action supports",
"definition" : "Identifies goals that this action supports. The reference must be to a goal element defined within this plan definition.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "id"
}]
},
{
"id" : "PlanDefinition.action.subject[x]",
"path" : "PlanDefinition.action.subject[x]",
"short" : "Type of individual the action is focused on",
"definition" : "A code or group definition that describes the intended subject of the action and its children, if any.",
"comment" : "The subject of an action overrides the subject at a parent action or on the root of the PlanDefinition if specified.\n\nIn addition, because the subject needs to be resolved during realization, use of subjects in actions (or in the ActivityDefinition referenced by the action) resolves based on the set of subjects supplied in context and by type (i.e. the patient subject would resolve to a resource of type Patient).",
"requirements" : "Multiple steps in a protocol often have different groups of steps that are focused on testing different things. The subject of an action specifies the focus of the action and any child actions.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
},
{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Group"]
}],
"meaningWhenMissing" : "Patient",
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SubjectType"
}],
"strength" : "extensible",
"description" : "The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).",
"valueSet" : "http://hl7.org/fhir/ValueSet/subject-type"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.subject"
}]
},
{
"id" : "PlanDefinition.action.trigger",
"path" : "PlanDefinition.action.trigger",
"short" : "When the action should be triggered",
"definition" : "A description of when the action should be triggered.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "TriggerDefinition"
}]
},
{
"id" : "PlanDefinition.action.condition",
"path" : "PlanDefinition.action.condition",
"short" : "Whether or not the action is applicable",
"definition" : "An expression that describes applicability criteria or start/stop conditions for the action.",
"comment" : "When multiple conditions of the same kind are present, the effects are combined using AND semantics, so the overall condition is true only if all the conditions are true.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "PlanDefinition.action.condition.kind",
"path" : "PlanDefinition.action.condition.kind",
"short" : "applicability | start | stop",
"definition" : "The kind of condition.",
"comment" : "Applicability criteria are used to determine immediate applicability when a plan definition is applied to a given context. Start and stop criteria are carried through application and used to describe enter/exit criteria for an action.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ActionConditionKind"
}],
"strength" : "required",
"description" : "Defines the kinds of conditions that can appear on actions.",
"valueSet" : "http://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1"
}
},
{
"id" : "PlanDefinition.action.condition.expression",
"path" : "PlanDefinition.action.condition.expression",
"short" : "Boolean-valued expression",
"definition" : "An expression that returns true or false, indicating whether the condition is satisfied.",
"comment" : "The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Expression"
}]
},
{
"id" : "PlanDefinition.action.input",
"path" : "PlanDefinition.action.input",
"short" : "Input data requirements",
"definition" : "Defines input data requirements for the action.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "DataRequirement"
}]
},
{
"id" : "PlanDefinition.action.output",
"path" : "PlanDefinition.action.output",
"short" : "Output data definition",
"definition" : "Defines the outputs of the action, if any.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "DataRequirement"
}]
},
{
"id" : "PlanDefinition.action.relatedAction",
"path" : "PlanDefinition.action.relatedAction",
"short" : "Relationship to another action",
"definition" : "A relationship to another action such as \"before\" or \"30-60 minutes after start of\".",
"comment" : "When an action depends on multiple actions, the meaning is that all actions are dependencies, rather than that any of the actions are a dependency.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "PlanDefinition.action.relatedAction.actionId",
"path" : "PlanDefinition.action.relatedAction.actionId",
"short" : "What action is this related to",
"definition" : "The element id of the related action.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "id"
}]
},
{
"id" : "PlanDefinition.action.relatedAction.relationship",
"path" : "PlanDefinition.action.relatedAction.relationship",
"short" : "before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end",
"definition" : "The relationship of this action to the related action.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ActionRelationshipType"
}],
"strength" : "required",
"description" : "Defines the types of relationships between actions.",
"valueSet" : "http://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1"
}
},
{
"id" : "PlanDefinition.action.relatedAction.offset[x]",
"path" : "PlanDefinition.action.relatedAction.offset[x]",
"short" : "Time offset for the relationship",
"definition" : "A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Duration"
},
{
"code" : "Range"
}]
},
{
"id" : "PlanDefinition.action.timing[x]",
"path" : "PlanDefinition.action.timing[x]",
"short" : "When the action should take place",
"definition" : "An optional value describing when the action should be performed.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "dateTime"
},
{
"code" : "Age"
},
{
"code" : "Period"
},
{
"code" : "Duration"
},
{
"code" : "Range"
},
{
"code" : "Timing"
}]
},
{
"id" : "PlanDefinition.action.participant",
"path" : "PlanDefinition.action.participant",
"short" : "Who should participate in the action",
"definition" : "Indicates who should participate in performing the action described.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "PlanDefinition.action.participant.type",
"path" : "PlanDefinition.action.participant.type",
"short" : "patient | practitioner | related-person | device",
"definition" : "The type of participant in the action.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ActionParticipantType"
}],
"strength" : "required",
"description" : "The type of participant for the action.",
"valueSet" : "http://hl7.org/fhir/ValueSet/action-participant-type|4.0.1"
}
},
{
"id" : "PlanDefinition.action.participant.role",
"path" : "PlanDefinition.action.participant.role",
"short" : "E.g. Nurse, Surgeon, Parent",
"definition" : "The role the participant should play in performing the described action.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ActionParticipantRole"
}],
"strength" : "example",
"description" : "Defines roles played by participants for the action.",
"valueSet" : "http://hl7.org/fhir/ValueSet/action-participant-role"
}
},
{
"id" : "PlanDefinition.action.type",
"path" : "PlanDefinition.action.type",
"short" : "create | update | remove | fire-event",
"definition" : "The type of action to perform (create, update, remove).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ActionType"
}],
"strength" : "extensible",
"description" : "The type of action to be performed.",
"valueSet" : "http://hl7.org/fhir/ValueSet/action-type"
}
},
{
"id" : "PlanDefinition.action.groupingBehavior",
"path" : "PlanDefinition.action.groupingBehavior",
"short" : "visual-group | logical-group | sentence-group",
"definition" : "Defines the grouping behavior for the action and its children.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "code"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ActionGroupingBehavior"
}],
"strength" : "required",
"description" : "Defines organization behavior of a group.",
"valueSet" : "http://hl7.org/fhir/ValueSet/action-grouping-behavior|4.0.1"
}
},
{
"id" : "PlanDefinition.action.selectionBehavior",
"path" : "PlanDefinition.action.selectionBehavior",
"short" : "any | all | all-or-none | exactly-one | at-most-one | one-or-more",
"definition" : "Defines the selection behavior for the action and its children.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "code"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ActionSelectionBehavior"
}],
"strength" : "required",
"description" : "Defines selection behavior of a group.",
"valueSet" : "http://hl7.org/fhir/ValueSet/action-selection-behavior|4.0.1"
}
},
{
"id" : "PlanDefinition.action.requiredBehavior",
"path" : "PlanDefinition.action.requiredBehavior",
"short" : "must | could | must-unless-documented",
"definition" : "Defines the required behavior for the action.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "code"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ActionRequiredBehavior"
}],
"strength" : "required",
"description" : "Defines expectations around whether an action or action group is required.",
"valueSet" : "http://hl7.org/fhir/ValueSet/action-required-behavior|4.0.1"
}
},
{
"id" : "PlanDefinition.action.precheckBehavior",
"path" : "PlanDefinition.action.precheckBehavior",
"short" : "yes | no",
"definition" : "Defines whether the action should usually be preselected.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "code"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ActionPrecheckBehavior"
}],
"strength" : "required",
"description" : "Defines selection frequency behavior for an action or group.",
"valueSet" : "http://hl7.org/fhir/ValueSet/action-precheck-behavior|4.0.1"
}
},
{
"id" : "PlanDefinition.action.cardinalityBehavior",
"path" : "PlanDefinition.action.cardinalityBehavior",
"short" : "single | multiple",
"definition" : "Defines whether the action can be selected multiple times.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "code"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ActionCardinalityBehavior"
}],
"strength" : "required",
"description" : "Defines behavior for an action or a group for how many times that item may be repeated.",
"valueSet" : "http://hl7.org/fhir/ValueSet/action-cardinality-behavior|4.0.1"
}
},
{
"id" : "PlanDefinition.action.definition[x]",
"path" : "PlanDefinition.action.definition[x]",
"short" : "Description of the activity to be performed",
"definition" : "A reference to an ActivityDefinition that describes the action to be taken in detail, or a PlanDefinition that describes a series of actions to be taken.",
"comment" : "Note that the definition is optional, and if no definition is specified, a dynamicValue with a root ($this) path can be used to define the entire resource dynamically.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ActivityDefinition",
"http://hl7.org/fhir/StructureDefinition/PlanDefinition",
"http://hl7.org/fhir/StructureDefinition/Questionnaire"]
},
{
"code" : "uri"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.derivedFrom"
}]
},
{
"id" : "PlanDefinition.action.transform",
"path" : "PlanDefinition.action.transform",
"short" : "Transform to apply the template",
"definition" : "A reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the input.",
"comment" : "Note that when a referenced ActivityDefinition also defines a transform, the transform specified here generally takes precedence. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/StructureMap"]
}]
},
{
"id" : "PlanDefinition.action.dynamicValue",
"path" : "PlanDefinition.action.dynamicValue",
"short" : "Dynamic aspects of the definition",
"definition" : "Customizations that should be applied to the statically defined resource. For example, if the dosage of a medication must be computed based on the patient's weight, a customization would be used to specify an expression that calculated the weight, and the path on the resource that would contain the result.",
"comment" : "Dynamic values are applied in the order in which they are defined in the PlanDefinition resource. Note that when dynamic values are also specified by a referenced ActivityDefinition, the dynamicValues from the ActivityDefinition are applied first, followed by the dynamicValues specified here. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "PlanDefinition.action.dynamicValue.path",
"path" : "PlanDefinition.action.dynamicValue.path",
"short" : "The path to the element to be set dynamically",
"definition" : "The path to the element to be customized. This is the path on the resource that will hold the result of the calculation defined by the expression. The specified path SHALL be a FHIRPath resolveable on the specified target type of the ActivityDefinition, and SHALL consist only of identifiers, constant indexers, and a restricted subset of functions. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the [Simple FHIRPath Profile](fhirpath.html#simple) for full details).",
"comment" : "To specify the path to the current action being realized, the %action environment variable is available in this path. For example, to specify the description element of the target action, the path would be %action.description. The path attribute contains a [Simple FHIRPath Subset](fhirpath.html#simple) that allows path traversal, but not calculation.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}]
},
{
"id" : "PlanDefinition.action.dynamicValue.expression",
"path" : "PlanDefinition.action.dynamicValue.expression",
"short" : "An expression that provides the dynamic value for the customization",
"definition" : "An expression specifying the value of the customized element.",
"comment" : "The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Expression"
}]
},
{
"id" : "PlanDefinition.action.action",
"path" : "PlanDefinition.action.action",
"short" : "A sub-action",
"definition" : "Sub actions that are contained within the action. The behavior of this action determines the functionality of the sub-actions. For example, a selection behavior of at-most-one indicates that of the sub-actions, at most one may be chosen as part of realizing the action definition.",
"min" : 0,
"max" : "*",
"contentReference" : "#PlanDefinition.action",
"mapping" : [{
"identity" : "workflow",
"map" : "{InverseRelationship of Definition.partOf}"
}]
}]
}
}
},
{
"fullUrl" : "http://hl7.org/fhir/StructureDefinition/Practitioner",
"resource" : {
"resourceType" : "StructureDefinition",
"id" : "Practitioner",
"meta" : {
"lastUpdated" : "2019-11-01T09:29:23.356+11:00"
},
"text" : {
"status" : "generated",
"div" : "Name Flags Card. Type Description & Constraints Practitioner 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 identifier Σ 0..* Identifier An identifier for the person as this agent
active Σ 0..1 boolean Whether this practitioner's record is in active use name Σ 0..* HumanName The name(s) associated with the practitioner
telecom Σ 0..* ContactPoint A contact detail for the practitioner (that apply to all roles)
address Σ 0..* Address Address(es) of the practitioner that are not role specific (typically home address)
gender Σ 0..1 code male | female | other | unknown
AdministrativeGender (Required) birthDate Σ 0..1 date The date on which the practitioner was born photo 0..* Attachment Image of the person
qualification 0..* BackboneElement Certification, licenses, or training pertaining to the provision of care
identifier 0..* Identifier An identifier for this qualification for the practitioner
code 1..1 CodeableConcept Coded representation of the qualification
v2 table 0360, Version 2.7 (Example) period 0..1 Period Period during which the qualification is valid issuer 0..1 Reference(Organization) Organization that regulates and issues the qualification communication 0..* CodeableConcept A language the practitioner can use in patient communication
Common Languages (Preferred but limited to AllLanguages)
Documentation for this format
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Base.Individuals"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 3
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "individual"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "pa"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/Practitioner",
"version" : "4.0.1",
"name" : "Practitioner",
"status" : "draft",
"date" : "2019-11-01T09:29:23+11:00",
"publisher" : "Health Level Seven International (Patient Administration)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/pafm/index.cfm"
}]
}],
"description" : "A person who is directly or indirectly involved in the provisioning of healthcare.",
"purpose" : "Need to track doctors, staff, locums etc. for both healthcare practitioners, funders, etc.",
"fhirVersion" : "4.0.1",
"mapping" : [{
"identity" : "v2",
"uri" : "http://hl7.org/v2",
"name" : "HL7 v2 Mapping"
},
{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
},
{
"identity" : "servd",
"uri" : "http://www.omg.org/spec/ServD/1.0/",
"name" : "ServD"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/fivews",
"name" : "FiveWs Pattern Mapping"
}],
"kind" : "resource",
"abstract" : false,
"type" : "Practitioner",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "Practitioner",
"path" : "Practitioner",
"short" : "A person with a formal responsibility in the provisioning of healthcare or related services",
"definition" : "A person who is directly or indirectly involved in the provisioning of healthcare.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Practitioner",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "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",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.`div`.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "v2",
"map" : "PRD (as one example)"
},
{
"identity" : "rim",
"map" : "Role"
},
{
"identity" : "servd",
"map" : "Provider"
}]
},
{
"id" : "Practitioner.id",
"path" : "Practitioner.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Practitioner.meta",
"path" : "Practitioner.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Practitioner.implicitRules",
"path" : "Practitioner.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "Practitioner.language",
"path" : "Practitioner.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "Practitioner.text",
"path" : "Practitioner.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "Practitioner.contained",
"path" : "Practitioner.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Practitioner.extension",
"path" : "Practitioner.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Practitioner.modifierExtension",
"path" : "Practitioner.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Practitioner.identifier",
"path" : "Practitioner.identifier",
"short" : "An identifier for the person as this agent",
"definition" : "An identifier that applies to this person in this role.",
"requirements" : "Often, specific identities are assigned for the agent.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Practitioner.identifier",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Identifier"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "v2",
"map" : "PRD-7 (or XCN.1)"
},
{
"identity" : "rim",
"map" : "./id"
},
{
"identity" : "servd",
"map" : "./Identifiers"
}]
},
{
"id" : "Practitioner.active",
"path" : "Practitioner.active",
"short" : "Whether this practitioner's record is in active use",
"definition" : "Whether this practitioner's record is in active use.",
"comment" : "If the practitioner is not in use by one organization, then it should mark the period on the PractitonerRole with an end date (even if they are active) as they may be active in another role.",
"requirements" : "Need to be able to mark a practitioner record as not to be used because it was created in error.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Practitioner.active",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"meaningWhenMissing" : "This resource is generally assumed to be active if no value is provided for the active element",
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.status"
},
{
"identity" : "rim",
"map" : "./statusCode"
}]
},
{
"id" : "Practitioner.name",
"path" : "Practitioner.name",
"short" : "The name(s) associated with the practitioner",
"definition" : "The name(s) associated with the practitioner.",
"comment" : "The selection of the use property should ensure that there is a single usual name specified, and others use the nickname (alias), old, or other values as appropriate. \r\rIn general, select the value to be used in the ResourceReference.display based on this:\r\r1. There is more than 1 name\r2. Use = usual\r3. Period is current to the date of the usage\r4. Use = official\r5. Other order as decided by internal business rules.",
"requirements" : "The name(s) that a Practitioner is known by. Where there are multiple, the name that the practitioner is usually known as should be used in the display.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Practitioner.name",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "HumanName"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "v2",
"map" : "XCN Components"
},
{
"identity" : "rim",
"map" : "./name"
},
{
"identity" : "servd",
"map" : "./PreferredName (GivenNames, FamilyName, TitleCode)"
}]
},
{
"id" : "Practitioner.telecom",
"path" : "Practitioner.telecom",
"short" : "A contact detail for the practitioner (that apply to all roles)",
"definition" : "A contact detail for the practitioner, e.g. a telephone number or an email address.",
"comment" : "Person may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and to help with identification. These typically will have home numbers, or mobile numbers that are not role specific.",
"requirements" : "Need to know how to reach a practitioner independent to any roles the practitioner may have.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Practitioner.telecom",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "ContactPoint"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "v2",
"map" : "PRT-15, STF-10, ROL-12"
},
{
"identity" : "rim",
"map" : "./telecom"
},
{
"identity" : "servd",
"map" : "./ContactPoints"
}]
},
{
"id" : "Practitioner.address",
"path" : "Practitioner.address",
"short" : "Address(es) of the practitioner that are not role specific (typically home address)",
"definition" : "Address(es) of the practitioner that are not role specific (typically home address). \rWork addresses are not typically entered in this property as they are usually role dependent.",
"comment" : "The PractitionerRole does not have an address value on it, as it is expected that the location property be used for this purpose (which has an address).",
"requirements" : "The home/mailing address of the practitioner is often required for employee administration purposes, and also for some rostering services where the start point (practitioners home) can be used in calculations.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Practitioner.address",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Address"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "v2",
"map" : "ORC-24, STF-11, ROL-11, PRT-14"
},
{
"identity" : "rim",
"map" : "./addr"
},
{
"identity" : "servd",
"map" : "./Addresses"
}]
},
{
"id" : "Practitioner.gender",
"path" : "Practitioner.gender",
"short" : "male | female | other | unknown",
"definition" : "Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.",
"requirements" : "Needed to address the person correctly.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Practitioner.gender",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AdministrativeGender"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "The gender of a person used for administrative purposes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1"
},
"mapping" : [{
"identity" : "v2",
"map" : "STF-5"
},
{
"identity" : "rim",
"map" : "./administrativeGender"
},
{
"identity" : "servd",
"map" : "./GenderCode"
}]
},
{
"id" : "Practitioner.birthDate",
"path" : "Practitioner.birthDate",
"short" : "The date on which the practitioner was born",
"definition" : "The date of birth for the practitioner.",
"requirements" : "Needed for identification.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Practitioner.birthDate",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "date"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "v2",
"map" : "STF-6"
},
{
"identity" : "rim",
"map" : "./birthTime"
},
{
"identity" : "servd",
"map" : "(not represented in ServD)"
}]
},
{
"id" : "Practitioner.photo",
"path" : "Practitioner.photo",
"short" : "Image of the person",
"definition" : "Image of the person.",
"requirements" : "Many EHR systems have the capability to capture an image of patients and personnel. Fits with newer social media usage too.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Practitioner.photo",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Attachment"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "./subjectOf/ObservationEvent[code=\"photo\"]/value"
},
{
"identity" : "servd",
"map" : "./ImageURI (only supports the URI reference)"
}]
},
{
"id" : "Practitioner.qualification",
"path" : "Practitioner.qualification",
"short" : "Certification, licenses, or training pertaining to the provision of care",
"definition" : "The official certifications, training, and licenses that authorize or otherwise pertain to the provision of care by the practitioner. For example, a medical license issued by a medical board authorizing the practitioner to practice medicine within a certian locality.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Practitioner.qualification",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "CER?"
},
{
"identity" : "rim",
"map" : ".playingEntity.playingRole[classCode=QUAL].code"
},
{
"identity" : "servd",
"map" : "./Qualifications"
}]
},
{
"id" : "Practitioner.qualification.id",
"path" : "Practitioner.qualification.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Practitioner.qualification.extension",
"path" : "Practitioner.qualification.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Practitioner.qualification.modifierExtension",
"path" : "Practitioner.qualification.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Practitioner.qualification.identifier",
"path" : "Practitioner.qualification.identifier",
"short" : "An identifier for this qualification for the practitioner",
"definition" : "An identifier that applies to this person's qualification in this role.",
"requirements" : "Often, specific identities are assigned for the qualification.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Practitioner.qualification.identifier",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Identifier"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".playingEntity.playingRole[classCode=QUAL].id"
}]
},
{
"id" : "Practitioner.qualification.code",
"path" : "Practitioner.qualification.code",
"short" : "Coded representation of the qualification",
"definition" : "Coded representation of the qualification.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Practitioner.qualification.code",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Qualification"
}],
"strength" : "example",
"description" : "Specific qualification the practitioner has to provide a service.",
"valueSet" : "http://terminology.hl7.org/ValueSet/v2-2.7-0360"
},
"mapping" : [{
"identity" : "rim",
"map" : ".playingEntity.playingRole[classCode=QUAL].code"
},
{
"identity" : "servd",
"map" : "./Qualifications.Value"
}]
},
{
"id" : "Practitioner.qualification.period",
"path" : "Practitioner.qualification.period",
"short" : "Period during which the qualification is valid",
"definition" : "Period during which the qualification is valid.",
"requirements" : "Qualifications are often for a limited period of time, and can be revoked.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Practitioner.qualification.period",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Period"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".playingEntity.playingRole[classCode=QUAL].effectiveTime"
},
{
"identity" : "servd",
"map" : "./Qualifications.StartDate and ./Qualifications.EndDate"
}]
},
{
"id" : "Practitioner.qualification.issuer",
"path" : "Practitioner.qualification.issuer",
"short" : "Organization that regulates and issues the qualification",
"definition" : "Organization that regulates and issues the qualification.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Practitioner.qualification.issuer",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".playingEntity.playingRole[classCode=QUAL].scoper"
}]
},
{
"id" : "Practitioner.communication",
"path" : "Practitioner.communication",
"short" : "A language the practitioner can use in patient communication",
"definition" : "A language the practitioner can use in patient communication.",
"comment" : "The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems code this but instead have it as free text. Hence CodeableConcept instead of code as the data type.",
"requirements" : "Knowing which language a practitioner speaks can help in facilitating communication with patients.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Practitioner.communication",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
},
"mapping" : [{
"identity" : "v2",
"map" : "PID-15, NK1-20, LAN-2"
},
{
"identity" : "rim",
"map" : "./languageCommunication"
},
{
"identity" : "servd",
"map" : "./Languages.LanguageSpokenCode"
}]
}]
},
"differential" : {
"element" : [{
"id" : "Practitioner",
"path" : "Practitioner",
"short" : "A person with a formal responsibility in the provisioning of healthcare or related services",
"definition" : "A person who is directly or indirectly involved in the provisioning of healthcare.",
"min" : 0,
"max" : "*",
"mapping" : [{
"identity" : "v2",
"map" : "PRD (as one example)"
},
{
"identity" : "rim",
"map" : "Role"
},
{
"identity" : "servd",
"map" : "Provider"
}]
},
{
"id" : "Practitioner.identifier",
"path" : "Practitioner.identifier",
"short" : "An identifier for the person as this agent",
"definition" : "An identifier that applies to this person in this role.",
"requirements" : "Often, specific identities are assigned for the agent.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Identifier"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "v2",
"map" : "PRD-7 (or XCN.1)"
},
{
"identity" : "rim",
"map" : "./id"
},
{
"identity" : "servd",
"map" : "./Identifiers"
}]
},
{
"id" : "Practitioner.active",
"path" : "Practitioner.active",
"short" : "Whether this practitioner's record is in active use",
"definition" : "Whether this practitioner's record is in active use.",
"comment" : "If the practitioner is not in use by one organization, then it should mark the period on the PractitonerRole with an end date (even if they are active) as they may be active in another role.",
"requirements" : "Need to be able to mark a practitioner record as not to be used because it was created in error.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "boolean"
}],
"meaningWhenMissing" : "This resource is generally assumed to be active if no value is provided for the active element",
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.status"
},
{
"identity" : "rim",
"map" : "./statusCode"
}]
},
{
"id" : "Practitioner.name",
"path" : "Practitioner.name",
"short" : "The name(s) associated with the practitioner",
"definition" : "The name(s) associated with the practitioner.",
"comment" : "The selection of the use property should ensure that there is a single usual name specified, and others use the nickname (alias), old, or other values as appropriate. \r\rIn general, select the value to be used in the ResourceReference.display based on this:\r\r1. There is more than 1 name\r2. Use = usual\r3. Period is current to the date of the usage\r4. Use = official\r5. Other order as decided by internal business rules.",
"requirements" : "The name(s) that a Practitioner is known by. Where there are multiple, the name that the practitioner is usually known as should be used in the display.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "HumanName"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "v2",
"map" : "XCN Components"
},
{
"identity" : "rim",
"map" : "./name"
},
{
"identity" : "servd",
"map" : "./PreferredName (GivenNames, FamilyName, TitleCode)"
}]
},
{
"id" : "Practitioner.telecom",
"path" : "Practitioner.telecom",
"short" : "A contact detail for the practitioner (that apply to all roles)",
"definition" : "A contact detail for the practitioner, e.g. a telephone number or an email address.",
"comment" : "Person may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and to help with identification. These typically will have home numbers, or mobile numbers that are not role specific.",
"requirements" : "Need to know how to reach a practitioner independent to any roles the practitioner may have.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "ContactPoint"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "v2",
"map" : "PRT-15, STF-10, ROL-12"
},
{
"identity" : "rim",
"map" : "./telecom"
},
{
"identity" : "servd",
"map" : "./ContactPoints"
}]
},
{
"id" : "Practitioner.address",
"path" : "Practitioner.address",
"short" : "Address(es) of the practitioner that are not role specific (typically home address)",
"definition" : "Address(es) of the practitioner that are not role specific (typically home address). \rWork addresses are not typically entered in this property as they are usually role dependent.",
"comment" : "The PractitionerRole does not have an address value on it, as it is expected that the location property be used for this purpose (which has an address).",
"requirements" : "The home/mailing address of the practitioner is often required for employee administration purposes, and also for some rostering services where the start point (practitioners home) can be used in calculations.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Address"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "v2",
"map" : "ORC-24, STF-11, ROL-11, PRT-14"
},
{
"identity" : "rim",
"map" : "./addr"
},
{
"identity" : "servd",
"map" : "./Addresses"
}]
},
{
"id" : "Practitioner.gender",
"path" : "Practitioner.gender",
"short" : "male | female | other | unknown",
"definition" : "Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.",
"requirements" : "Needed to address the person correctly.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AdministrativeGender"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "The gender of a person used for administrative purposes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1"
},
"mapping" : [{
"identity" : "v2",
"map" : "STF-5"
},
{
"identity" : "rim",
"map" : "./administrativeGender"
},
{
"identity" : "servd",
"map" : "./GenderCode"
}]
},
{
"id" : "Practitioner.birthDate",
"path" : "Practitioner.birthDate",
"short" : "The date on which the practitioner was born",
"definition" : "The date of birth for the practitioner.",
"requirements" : "Needed for identification.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "date"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "v2",
"map" : "STF-6"
},
{
"identity" : "rim",
"map" : "./birthTime"
},
{
"identity" : "servd",
"map" : "(not represented in ServD)"
}]
},
{
"id" : "Practitioner.photo",
"path" : "Practitioner.photo",
"short" : "Image of the person",
"definition" : "Image of the person.",
"requirements" : "Many EHR systems have the capability to capture an image of patients and personnel. Fits with newer social media usage too.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Attachment"
}],
"mapping" : [{
"identity" : "rim",
"map" : "./subjectOf/ObservationEvent[code=\"photo\"]/value"
},
{
"identity" : "servd",
"map" : "./ImageURI (only supports the URI reference)"
}]
},
{
"id" : "Practitioner.qualification",
"path" : "Practitioner.qualification",
"short" : "Certification, licenses, or training pertaining to the provision of care",
"definition" : "The official certifications, training, and licenses that authorize or otherwise pertain to the provision of care by the practitioner. For example, a medical license issued by a medical board authorizing the practitioner to practice medicine within a certian locality.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"mapping" : [{
"identity" : "v2",
"map" : "CER?"
},
{
"identity" : "rim",
"map" : ".playingEntity.playingRole[classCode=QUAL].code"
},
{
"identity" : "servd",
"map" : "./Qualifications"
}]
},
{
"id" : "Practitioner.qualification.identifier",
"path" : "Practitioner.qualification.identifier",
"short" : "An identifier for this qualification for the practitioner",
"definition" : "An identifier that applies to this person's qualification in this role.",
"requirements" : "Often, specific identities are assigned for the qualification.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Identifier"
}],
"mapping" : [{
"identity" : "rim",
"map" : ".playingEntity.playingRole[classCode=QUAL].id"
}]
},
{
"id" : "Practitioner.qualification.code",
"path" : "Practitioner.qualification.code",
"short" : "Coded representation of the qualification",
"definition" : "Coded representation of the qualification.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Qualification"
}],
"strength" : "example",
"description" : "Specific qualification the practitioner has to provide a service.",
"valueSet" : "http://terminology.hl7.org/ValueSet/v2-2.7-0360"
},
"mapping" : [{
"identity" : "rim",
"map" : ".playingEntity.playingRole[classCode=QUAL].code"
},
{
"identity" : "servd",
"map" : "./Qualifications.Value"
}]
},
{
"id" : "Practitioner.qualification.period",
"path" : "Practitioner.qualification.period",
"short" : "Period during which the qualification is valid",
"definition" : "Period during which the qualification is valid.",
"requirements" : "Qualifications are often for a limited period of time, and can be revoked.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Period"
}],
"mapping" : [{
"identity" : "rim",
"map" : ".playingEntity.playingRole[classCode=QUAL].effectiveTime"
},
{
"identity" : "servd",
"map" : "./Qualifications.StartDate and ./Qualifications.EndDate"
}]
},
{
"id" : "Practitioner.qualification.issuer",
"path" : "Practitioner.qualification.issuer",
"short" : "Organization that regulates and issues the qualification",
"definition" : "Organization that regulates and issues the qualification.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"mapping" : [{
"identity" : "rim",
"map" : ".playingEntity.playingRole[classCode=QUAL].scoper"
}]
},
{
"id" : "Practitioner.communication",
"path" : "Practitioner.communication",
"short" : "A language the practitioner can use in patient communication",
"definition" : "A language the practitioner can use in patient communication.",
"comment" : "The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems code this but instead have it as free text. Hence CodeableConcept instead of code as the data type.",
"requirements" : "Knowing which language a practitioner speaks can help in facilitating communication with patients.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
},
"mapping" : [{
"identity" : "v2",
"map" : "PID-15, NK1-20, LAN-2"
},
{
"identity" : "rim",
"map" : "./languageCommunication"
},
{
"identity" : "servd",
"map" : "./Languages.LanguageSpokenCode"
}]
}]
}
}
},
{
"fullUrl" : "http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"resource" : {
"resourceType" : "StructureDefinition",
"id" : "PractitionerRole",
"meta" : {
"lastUpdated" : "2019-11-01T09:29:23.356+11:00"
},
"text" : {
"status" : "generated",
"div" : "Name Flags Card. Type Description & Constraints PractitionerRole TU DomainResource Roles/organizations the practitioner is associated with
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension identifier Σ 0..* Identifier Business Identifiers that are specific to a role/location
active Σ 0..1 boolean Whether this practitioner role record is in active use period Σ 0..1 Period The period during which the practitioner is authorized to perform in these role(s) practitioner Σ 0..1 Reference(Practitioner) Practitioner that is able to provide the defined services for the organization organization Σ 0..1 Reference(Organization) Organization where the roles are available code Σ 0..* CodeableConcept Roles which this practitioner may perform
Practitioner role (Example)
specialty Σ 0..* CodeableConcept Specific specialty of the practitioner
Practice Setting Code Value Set (Preferred)
location Σ 0..* Reference(Location) The location(s) at which this practitioner provides care
healthcareService 0..* Reference(HealthcareService) The list of healthcare services that this worker provides for this role's Organization/Location(s)
telecom Σ 0..* ContactPoint Contact details that are specific to the role/location/service
availableTime 0..* BackboneElement Times the Service Site is available
daysOfWeek 0..* code mon | tue | wed | thu | fri | sat | sun
DaysOfWeek (Required)
allDay 0..1 boolean Always available? e.g. 24 hour service availableStartTime 0..1 time Opening time of day (ignored if allDay = true) availableEndTime 0..1 time Closing time of day (ignored if allDay = true) notAvailable 0..* BackboneElement Not available during this time due to provided reason
description 1..1 string Reason presented to the user explaining why time not available during 0..1 Period Service not available from this date availabilityExceptions 0..1 string Description of availability exceptions endpoint 0..* Reference(Endpoint) Technical endpoints providing access to services operated for the practitioner with this role
Documentation for this format
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Base.Individuals"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 2
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "individual"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "pa"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"version" : "4.0.1",
"name" : "PractitionerRole",
"status" : "draft",
"date" : "2019-11-01T09:29:23+11:00",
"publisher" : "Health Level Seven International (Patient Administration)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/pafm/index.cfm"
}]
}],
"description" : "A specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time.",
"purpose" : "Need to track services that a healthcare provider is able to provide at an organization's location, and the services that they can perform there.",
"fhirVersion" : "4.0.1",
"mapping" : [{
"identity" : "v2",
"uri" : "http://hl7.org/v2",
"name" : "HL7 v2 Mapping"
},
{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
},
{
"identity" : "servd",
"uri" : "http://www.omg.org/spec/ServD/1.0/",
"name" : "ServD"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/fivews",
"name" : "FiveWs Pattern Mapping"
}],
"kind" : "resource",
"abstract" : false,
"type" : "PractitionerRole",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "PractitionerRole",
"path" : "PractitionerRole",
"short" : "Roles/organizations the practitioner is associated with",
"definition" : "A specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "PractitionerRole",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "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",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.`div`.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "v2",
"map" : "PRD (as one example)"
},
{
"identity" : "rim",
"map" : "Role"
},
{
"identity" : "servd",
"map" : "ServiceSiteProvider"
}]
},
{
"id" : "PractitionerRole.id",
"path" : "PractitionerRole.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "PractitionerRole.meta",
"path" : "PractitionerRole.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "PractitionerRole.implicitRules",
"path" : "PractitionerRole.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "PractitionerRole.language",
"path" : "PractitionerRole.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "PractitionerRole.text",
"path" : "PractitionerRole.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "PractitionerRole.contained",
"path" : "PractitionerRole.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "PractitionerRole.extension",
"path" : "PractitionerRole.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "PractitionerRole.modifierExtension",
"path" : "PractitionerRole.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "PractitionerRole.identifier",
"path" : "PractitionerRole.identifier",
"short" : "Business Identifiers that are specific to a role/location",
"definition" : "Business Identifiers that are specific to a role/location.",
"requirements" : "Often, specific identities are assigned for the agent.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "PractitionerRole.identifier",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Identifier"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "v2",
"map" : "PRD-7 (or XCN.1)"
},
{
"identity" : "rim",
"map" : ".id"
},
{
"identity" : "servd",
"map" : "./Identifiers"
}]
},
{
"id" : "PractitionerRole.active",
"path" : "PractitionerRole.active",
"short" : "Whether this practitioner role record is in active use",
"definition" : "Whether this practitioner role record is in active use.",
"comment" : "If this value is false, you may refer to the period to see when the role was in active use. If there is no period specified, no inference can be made about when it was active.",
"requirements" : "Need to be able to mark a practitioner role record as not to be used because it was created in error, or otherwise no longer in active use.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "PractitionerRole.active",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"meaningWhenMissing" : "This resource is generally assumed to be active if no value is provided for the active element",
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.status"
},
{
"identity" : "v2",
"map" : "STF-7"
},
{
"identity" : "rim",
"map" : ".statusCode"
}]
},
{
"id" : "PractitionerRole.period",
"path" : "PractitionerRole.period",
"short" : "The period during which the practitioner is authorized to perform in these role(s)",
"definition" : "The period during which the person is authorized to act as a practitioner in these role(s) for the organization.",
"requirements" : "Even after the agencies is revoked, the fact that it existed must still be recorded.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "PractitionerRole.period",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Period"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.done[x]"
},
{
"identity" : "v2",
"map" : "PRD-8/9 / PRA-5.4"
},
{
"identity" : "rim",
"map" : ".performance[@typeCode <= 'PPRF'].ActDefinitionOrEvent.effectiveTime"
},
{
"identity" : "servd",
"map" : "(ServD maps Practitioners and Organizations via another entity, so this concept is not available)"
}]
},
{
"id" : "PractitionerRole.practitioner",
"path" : "PractitionerRole.practitioner",
"short" : "Practitioner that is able to provide the defined services for the organization",
"definition" : "Practitioner that is able to provide the defined services for the organization.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "PractitionerRole.practitioner",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : ".player"
}]
},
{
"id" : "PractitionerRole.organization",
"path" : "PractitionerRole.organization",
"short" : "Organization where the roles are available",
"definition" : "The organization where the Practitioner performs the roles associated.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "PractitionerRole.organization",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : ".scoper"
}]
},
{
"id" : "PractitionerRole.code",
"path" : "PractitionerRole.code",
"short" : "Roles which this practitioner may perform",
"definition" : "Roles which this practitioner is authorized to perform for the organization.",
"comment" : "A person may have more than one role.",
"requirements" : "Need to know what authority the practitioner has - what can they do?",
"min" : 0,
"max" : "*",
"base" : {
"path" : "PractitionerRole.code",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "PractitionerRole"
}],
"strength" : "example",
"description" : "The role a person plays representing an organization.",
"valueSet" : "http://hl7.org/fhir/ValueSet/practitioner-role"
},
"mapping" : [{
"identity" : "v2",
"map" : "PRD-1 / STF-18 / PRA-3 / PRT-4 / ROL-3 / ORC-12 / OBR-16 / PV1-7 / PV1-8 / PV1-9 / PV1-17"
},
{
"identity" : "rim",
"map" : ".code"
},
{
"identity" : "servd",
"map" : "(ServD maps Practitioners and Organizations via another entity, so this concept is not available)"
}]
},
{
"id" : "PractitionerRole.specialty",
"path" : "PractitionerRole.specialty",
"short" : "Specific specialty of the practitioner",
"definition" : "Specific specialty of the practitioner.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "PractitionerRole.specialty",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "PractitionerSpecialty"
}],
"strength" : "preferred",
"description" : "Specific specialty associated with the agency.",
"valueSet" : "http://hl7.org/fhir/ValueSet/c80-practice-codes"
},
"mapping" : [{
"identity" : "v2",
"map" : "PRA-5"
},
{
"identity" : "rim",
"map" : ".player.HealthCareProvider[@classCode = 'PROV'].code"
},
{
"identity" : "servd",
"map" : "./Specialty"
}]
},
{
"id" : "PractitionerRole.location",
"path" : "PractitionerRole.location",
"short" : "The location(s) at which this practitioner provides care",
"definition" : "The location(s) at which this practitioner provides care.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "PractitionerRole.location",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Location"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.where[x]"
},
{
"identity" : "rim",
"map" : ".performance.ActDefinitionOrEvent.ServiceDeliveryLocation[@classCode = 'SDLOC']"
},
{
"identity" : "servd",
"map" : "(ServD maps Practitioners and Organizations via another entity, so this concept is not available)
However these are accessed via the Site.ServiceSite.ServiceSiteProvider record. (The Site has the location)"
}]
},
{
"id" : "PractitionerRole.healthcareService",
"path" : "PractitionerRole.healthcareService",
"short" : "The list of healthcare services that this worker provides for this role's Organization/Location(s)",
"definition" : "The list of healthcare services that this worker provides for this role's Organization/Location(s).",
"min" : 0,
"max" : "*",
"base" : {
"path" : "PractitionerRole.healthcareService",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/HealthcareService"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "EDU-2 / AFF-3"
},
{
"identity" : "rim",
"map" : ".player.QualifiedEntity[@classCode = 'QUAL'].code"
}]
},
{
"id" : "PractitionerRole.telecom",
"path" : "PractitionerRole.telecom",
"short" : "Contact details that are specific to the role/location/service",
"definition" : "Contact details that are specific to the role/location/service.",
"requirements" : "Often practitioners have a dedicated line for each location (or service) that they work at, and need to be able to define separate contact details for each of these.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "PractitionerRole.telecom",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "ContactPoint"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : ".telecom"
}]
},
{
"id" : "PractitionerRole.availableTime",
"path" : "PractitionerRole.availableTime",
"short" : "Times the Service Site is available",
"definition" : "A collection of times the practitioner is available or performing this role at the location and/or healthcareservice.",
"comment" : "More detailed availability information may be provided in associated Schedule/Slot resources.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "PractitionerRole.availableTime",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".effectiveTime"
}]
},
{
"id" : "PractitionerRole.availableTime.id",
"path" : "PractitionerRole.availableTime.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "PractitionerRole.availableTime.extension",
"path" : "PractitionerRole.availableTime.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "PractitionerRole.availableTime.modifierExtension",
"path" : "PractitionerRole.availableTime.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "PractitionerRole.availableTime.daysOfWeek",
"path" : "PractitionerRole.availableTime.daysOfWeek",
"short" : "mon | tue | wed | thu | fri | sat | sun",
"definition" : "Indicates which days of the week are available between the start and end Times.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "PractitionerRole.availableTime.daysOfWeek",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "DaysOfWeek"
}],
"strength" : "required",
"description" : "The days of the week.",
"valueSet" : "http://hl7.org/fhir/ValueSet/days-of-week|4.0.1"
},
"mapping" : [{
"identity" : "rim",
"map" : ".effectiveTime"
}]
},
{
"id" : "PractitionerRole.availableTime.allDay",
"path" : "PractitionerRole.availableTime.allDay",
"short" : "Always available? e.g. 24 hour service",
"definition" : "Is this always available? (hence times are irrelevant) e.g. 24 hour service.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "PractitionerRole.availableTime.allDay",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".effectiveTime"
}]
},
{
"id" : "PractitionerRole.availableTime.availableStartTime",
"path" : "PractitionerRole.availableTime.availableStartTime",
"short" : "Opening time of day (ignored if allDay = true)",
"definition" : "The opening time of day. Note: If the AllDay flag is set, then this time is ignored.",
"comment" : "The timezone is expected to be for where this HealthcareService is provided at.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "PractitionerRole.availableTime.availableStartTime",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "time"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".effectiveTime"
}]
},
{
"id" : "PractitionerRole.availableTime.availableEndTime",
"path" : "PractitionerRole.availableTime.availableEndTime",
"short" : "Closing time of day (ignored if allDay = true)",
"definition" : "The closing time of day. Note: If the AllDay flag is set, then this time is ignored.",
"comment" : "The timezone is expected to be for where this HealthcareService is provided at.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "PractitionerRole.availableTime.availableEndTime",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "time"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".effectiveTime"
}]
},
{
"id" : "PractitionerRole.notAvailable",
"path" : "PractitionerRole.notAvailable",
"short" : "Not available during this time due to provided reason",
"definition" : "The practitioner is not available or performing this role during this period of time due to the provided reason.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "PractitionerRole.notAvailable",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".effectiveTime"
}]
},
{
"id" : "PractitionerRole.notAvailable.id",
"path" : "PractitionerRole.notAvailable.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "PractitionerRole.notAvailable.extension",
"path" : "PractitionerRole.notAvailable.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "PractitionerRole.notAvailable.modifierExtension",
"path" : "PractitionerRole.notAvailable.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "PractitionerRole.notAvailable.description",
"path" : "PractitionerRole.notAvailable.description",
"short" : "Reason presented to the user explaining why time not available",
"definition" : "The reason that can be presented to the user as to why this time is not available.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "PractitionerRole.notAvailable.description",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "PractitionerRole.notAvailable.during",
"path" : "PractitionerRole.notAvailable.during",
"short" : "Service not available from this date",
"definition" : "Service is not available (seasonally or for a public holiday) from this date.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "PractitionerRole.notAvailable.during",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Period"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".effectiveTime"
}]
},
{
"id" : "PractitionerRole.availabilityExceptions",
"path" : "PractitionerRole.availabilityExceptions",
"short" : "Description of availability exceptions",
"definition" : "A description of site availability exceptions, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as details in the available Times and not available Times.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "PractitionerRole.availabilityExceptions",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".effectiveTime"
}]
},
{
"id" : "PractitionerRole.endpoint",
"path" : "PractitionerRole.endpoint",
"short" : "Technical endpoints providing access to services operated for the practitioner with this role",
"definition" : "Technical endpoints providing access to services operated for the practitioner with this role.",
"requirements" : "Organizations have multiple systems that provide various services and ,ay also be different for practitioners too.\r\rSo the endpoint satisfies the need to be able to define the technical connection details for how to connect to them, and for what purpose.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "PractitionerRole.endpoint",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Endpoint"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
}]
},
"differential" : {
"element" : [{
"id" : "PractitionerRole",
"path" : "PractitionerRole",
"short" : "Roles/organizations the practitioner is associated with",
"definition" : "A specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time.",
"min" : 0,
"max" : "*",
"mapping" : [{
"identity" : "v2",
"map" : "PRD (as one example)"
},
{
"identity" : "rim",
"map" : "Role"
},
{
"identity" : "servd",
"map" : "ServiceSiteProvider"
}]
},
{
"id" : "PractitionerRole.identifier",
"path" : "PractitionerRole.identifier",
"short" : "Business Identifiers that are specific to a role/location",
"definition" : "Business Identifiers that are specific to a role/location.",
"requirements" : "Often, specific identities are assigned for the agent.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Identifier"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "v2",
"map" : "PRD-7 (or XCN.1)"
},
{
"identity" : "rim",
"map" : ".id"
},
{
"identity" : "servd",
"map" : "./Identifiers"
}]
},
{
"id" : "PractitionerRole.active",
"path" : "PractitionerRole.active",
"short" : "Whether this practitioner role record is in active use",
"definition" : "Whether this practitioner role record is in active use.",
"comment" : "If this value is false, you may refer to the period to see when the role was in active use. If there is no period specified, no inference can be made about when it was active.",
"requirements" : "Need to be able to mark a practitioner role record as not to be used because it was created in error, or otherwise no longer in active use.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "boolean"
}],
"meaningWhenMissing" : "This resource is generally assumed to be active if no value is provided for the active element",
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.status"
},
{
"identity" : "v2",
"map" : "STF-7"
},
{
"identity" : "rim",
"map" : ".statusCode"
}]
},
{
"id" : "PractitionerRole.period",
"path" : "PractitionerRole.period",
"short" : "The period during which the practitioner is authorized to perform in these role(s)",
"definition" : "The period during which the person is authorized to act as a practitioner in these role(s) for the organization.",
"requirements" : "Even after the agencies is revoked, the fact that it existed must still be recorded.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Period"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.done[x]"
},
{
"identity" : "v2",
"map" : "PRD-8/9 / PRA-5.4"
},
{
"identity" : "rim",
"map" : ".performance[@typeCode <= 'PPRF'].ActDefinitionOrEvent.effectiveTime"
},
{
"identity" : "servd",
"map" : "(ServD maps Practitioners and Organizations via another entity, so this concept is not available)"
}]
},
{
"id" : "PractitionerRole.practitioner",
"path" : "PractitionerRole.practitioner",
"short" : "Practitioner that is able to provide the defined services for the organization",
"definition" : "Practitioner that is able to provide the defined services for the organization.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : ".player"
}]
},
{
"id" : "PractitionerRole.organization",
"path" : "PractitionerRole.organization",
"short" : "Organization where the roles are available",
"definition" : "The organization where the Practitioner performs the roles associated.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : ".scoper"
}]
},
{
"id" : "PractitionerRole.code",
"path" : "PractitionerRole.code",
"short" : "Roles which this practitioner may perform",
"definition" : "Roles which this practitioner is authorized to perform for the organization.",
"comment" : "A person may have more than one role.",
"requirements" : "Need to know what authority the practitioner has - what can they do?",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "PractitionerRole"
}],
"strength" : "example",
"description" : "The role a person plays representing an organization.",
"valueSet" : "http://hl7.org/fhir/ValueSet/practitioner-role"
},
"mapping" : [{
"identity" : "v2",
"map" : "PRD-1 / STF-18 / PRA-3 / PRT-4 / ROL-3 / ORC-12 / OBR-16 / PV1-7 / PV1-8 / PV1-9 / PV1-17"
},
{
"identity" : "rim",
"map" : ".code"
},
{
"identity" : "servd",
"map" : "(ServD maps Practitioners and Organizations via another entity, so this concept is not available)"
}]
},
{
"id" : "PractitionerRole.specialty",
"path" : "PractitionerRole.specialty",
"short" : "Specific specialty of the practitioner",
"definition" : "Specific specialty of the practitioner.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "PractitionerSpecialty"
}],
"strength" : "preferred",
"description" : "Specific specialty associated with the agency.",
"valueSet" : "http://hl7.org/fhir/ValueSet/c80-practice-codes"
},
"mapping" : [{
"identity" : "v2",
"map" : "PRA-5"
},
{
"identity" : "rim",
"map" : ".player.HealthCareProvider[@classCode = 'PROV'].code"
},
{
"identity" : "servd",
"map" : "./Specialty"
}]
},
{
"id" : "PractitionerRole.location",
"path" : "PractitionerRole.location",
"short" : "The location(s) at which this practitioner provides care",
"definition" : "The location(s) at which this practitioner provides care.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Location"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.where[x]"
},
{
"identity" : "rim",
"map" : ".performance.ActDefinitionOrEvent.ServiceDeliveryLocation[@classCode = 'SDLOC']"
},
{
"identity" : "servd",
"map" : "(ServD maps Practitioners and Organizations via another entity, so this concept is not available)
However these are accessed via the Site.ServiceSite.ServiceSiteProvider record. (The Site has the location)"
}]
},
{
"id" : "PractitionerRole.healthcareService",
"path" : "PractitionerRole.healthcareService",
"short" : "The list of healthcare services that this worker provides for this role's Organization/Location(s)",
"definition" : "The list of healthcare services that this worker provides for this role's Organization/Location(s).",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/HealthcareService"]
}],
"mapping" : [{
"identity" : "v2",
"map" : "EDU-2 / AFF-3"
},
{
"identity" : "rim",
"map" : ".player.QualifiedEntity[@classCode = 'QUAL'].code"
}]
},
{
"id" : "PractitionerRole.telecom",
"path" : "PractitionerRole.telecom",
"short" : "Contact details that are specific to the role/location/service",
"definition" : "Contact details that are specific to the role/location/service.",
"requirements" : "Often practitioners have a dedicated line for each location (or service) that they work at, and need to be able to define separate contact details for each of these.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "ContactPoint"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : ".telecom"
}]
},
{
"id" : "PractitionerRole.availableTime",
"path" : "PractitionerRole.availableTime",
"short" : "Times the Service Site is available",
"definition" : "A collection of times the practitioner is available or performing this role at the location and/or healthcareservice.",
"comment" : "More detailed availability information may be provided in associated Schedule/Slot resources.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"mapping" : [{
"identity" : "rim",
"map" : ".effectiveTime"
}]
},
{
"id" : "PractitionerRole.availableTime.daysOfWeek",
"path" : "PractitionerRole.availableTime.daysOfWeek",
"short" : "mon | tue | wed | thu | fri | sat | sun",
"definition" : "Indicates which days of the week are available between the start and end Times.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "code"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "DaysOfWeek"
}],
"strength" : "required",
"description" : "The days of the week.",
"valueSet" : "http://hl7.org/fhir/ValueSet/days-of-week|4.0.1"
},
"mapping" : [{
"identity" : "rim",
"map" : ".effectiveTime"
}]
},
{
"id" : "PractitionerRole.availableTime.allDay",
"path" : "PractitionerRole.availableTime.allDay",
"short" : "Always available? e.g. 24 hour service",
"definition" : "Is this always available? (hence times are irrelevant) e.g. 24 hour service.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "boolean"
}],
"mapping" : [{
"identity" : "rim",
"map" : ".effectiveTime"
}]
},
{
"id" : "PractitionerRole.availableTime.availableStartTime",
"path" : "PractitionerRole.availableTime.availableStartTime",
"short" : "Opening time of day (ignored if allDay = true)",
"definition" : "The opening time of day. Note: If the AllDay flag is set, then this time is ignored.",
"comment" : "The timezone is expected to be for where this HealthcareService is provided at.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "time"
}],
"mapping" : [{
"identity" : "rim",
"map" : ".effectiveTime"
}]
},
{
"id" : "PractitionerRole.availableTime.availableEndTime",
"path" : "PractitionerRole.availableTime.availableEndTime",
"short" : "Closing time of day (ignored if allDay = true)",
"definition" : "The closing time of day. Note: If the AllDay flag is set, then this time is ignored.",
"comment" : "The timezone is expected to be for where this HealthcareService is provided at.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "time"
}],
"mapping" : [{
"identity" : "rim",
"map" : ".effectiveTime"
}]
},
{
"id" : "PractitionerRole.notAvailable",
"path" : "PractitionerRole.notAvailable",
"short" : "Not available during this time due to provided reason",
"definition" : "The practitioner is not available or performing this role during this period of time due to the provided reason.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"mapping" : [{
"identity" : "rim",
"map" : ".effectiveTime"
}]
},
{
"id" : "PractitionerRole.notAvailable.description",
"path" : "PractitionerRole.notAvailable.description",
"short" : "Reason presented to the user explaining why time not available",
"definition" : "The reason that can be presented to the user as to why this time is not available.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "string"
}],
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "PractitionerRole.notAvailable.during",
"path" : "PractitionerRole.notAvailable.during",
"short" : "Service not available from this date",
"definition" : "Service is not available (seasonally or for a public holiday) from this date.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Period"
}],
"mapping" : [{
"identity" : "rim",
"map" : ".effectiveTime"
}]
},
{
"id" : "PractitionerRole.availabilityExceptions",
"path" : "PractitionerRole.availabilityExceptions",
"short" : "Description of availability exceptions",
"definition" : "A description of site availability exceptions, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as details in the available Times and not available Times.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"mapping" : [{
"identity" : "rim",
"map" : ".effectiveTime"
}]
},
{
"id" : "PractitionerRole.endpoint",
"path" : "PractitionerRole.endpoint",
"short" : "Technical endpoints providing access to services operated for the practitioner with this role",
"definition" : "Technical endpoints providing access to services operated for the practitioner with this role.",
"requirements" : "Organizations have multiple systems that provide various services and ,ay also be different for practitioners too.\r\rSo the endpoint satisfies the need to be able to define the technical connection details for how to connect to them, and for what purpose.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Endpoint"]
}],
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
}]
}
}
},
{
"fullUrl" : "http://hl7.org/fhir/StructureDefinition/Procedure",
"resource" : {
"resourceType" : "StructureDefinition",
"id" : "Procedure",
"meta" : {
"lastUpdated" : "2019-11-01T09:29:23.356+11:00"
},
"text" : {
"status" : "generated",
"div" : "Name Flags Card. Type Description & Constraints Procedure TU DomainResource An action that is being or was performed on a patient
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension identifier Σ 0..* Identifier External Identifiers for this procedure
instantiatesCanonical Σ 0..* canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire) Instantiates FHIR protocol or definition
instantiatesUri Σ 0..* uri Instantiates external protocol or definition
basedOn Σ 0..* Reference(CarePlan | ServiceRequest) A request for this procedure
partOf Σ 0..* Reference(Procedure | Observation | MedicationAdministration) Part of referenced event
status ?!Σ 1..1 code preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
EventStatus (Required) statusReason Σ 0..1 CodeableConcept Reason for current status
Procedure Not Performed Reason (SNOMED-CT) (Example) category Σ 0..1 CodeableConcept Classification of the procedure
Procedure Category Codes (SNOMED CT) (Example) code Σ 0..1 CodeableConcept Identification of the procedure
Procedure Codes (SNOMED CT) (Example) subject Σ 1..1 Reference(Patient | Group) Who the procedure was performed on encounter Σ 0..1 Reference(Encounter) Encounter created as part of performed[x] Σ 0..1 When the procedure was performed performedDateTime dateTime performedPeriod Period performedString string performedAge Age performedRange Range recorder Σ 0..1 Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) Who recorded the procedure asserter Σ 0..1 Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) Person who asserts this procedure performer Σ 0..* BackboneElement The people who performed the procedure
function Σ 0..1 CodeableConcept Type of performance
Procedure Performer Role Codes (Example) actor Σ 1..1 Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) The reference to the practitioner onBehalfOf 0..1 Reference(Organization) Organization the device or practitioner was acting for location Σ 0..1 Reference(Location) Where the procedure happened reasonCode Σ 0..* CodeableConcept Coded reason procedure performed
Procedure Reason Codes (Example)
reasonReference Σ 0..* Reference(Condition | Observation | Procedure | DiagnosticReport | DocumentReference) The justification that the procedure was performed
bodySite Σ 0..* CodeableConcept Target body sites
SNOMED CT Body Structures (Example)
outcome Σ 0..1 CodeableConcept The result of procedure
Procedure Outcome Codes (SNOMED CT) (Example) report 0..* Reference(DiagnosticReport | DocumentReference | Composition) Any report resulting from the procedure
complication 0..* CodeableConcept Complication following the procedure
Condition/Problem/Diagnosis Codes (Example)
complicationDetail 0..* Reference(Condition) A condition that is a result of the procedure
followUp 0..* CodeableConcept Instructions for follow up
Procedure Follow up Codes (SNOMED CT) (Example)
note 0..* Annotation Additional information about the procedure
focalDevice 0..* BackboneElement Manipulated, implanted, or removed device
action 0..1 CodeableConcept Kind of change to device
Procedure Device Action Codes (Preferred) manipulated 1..1 Reference(Device) Device that was changed usedReference 0..* Reference(Device | Medication | Substance) Items used during procedure
usedCode 0..* CodeableConcept Coded items used during the procedure
FHIR Device Types (Example)
Documentation for this format
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Clinical.Summary"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 3
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "patient"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "pc"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/Procedure",
"version" : "4.0.1",
"name" : "Procedure",
"status" : "draft",
"date" : "2019-11-01T09:29:23+11:00",
"publisher" : "Health Level Seven International (Patient Care)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/patientcare/index.cfm"
}]
}],
"description" : "An action that is or was performed on or for a patient. This can be a physical intervention like an operation, or less invasive like long term services, counseling, or hypnotherapy.",
"fhirVersion" : "4.0.1",
"mapping" : [{
"identity" : "workflow",
"uri" : "http://hl7.org/fhir/workflow",
"name" : "Workflow Pattern"
},
{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/fivews",
"name" : "FiveWs Pattern Mapping"
},
{
"identity" : "v2",
"uri" : "http://hl7.org/v2",
"name" : "HL7 v2 Mapping"
}],
"kind" : "resource",
"abstract" : false,
"type" : "Procedure",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "Procedure",
"path" : "Procedure",
"short" : "An action that is being or was performed on a patient",
"definition" : "An action that is or was performed on or for a patient. This can be a physical intervention like an operation, or less invasive like long term services, counseling, or hypnotherapy.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Procedure",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "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",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.`div`.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "workflow",
"map" : "Event"
},
{
"identity" : "rim",
"map" : "Procedure[moodCode=EVN]"
}]
},
{
"id" : "Procedure.id",
"path" : "Procedure.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Procedure.meta",
"path" : "Procedure.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Procedure.implicitRules",
"path" : "Procedure.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "Procedure.language",
"path" : "Procedure.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "Procedure.text",
"path" : "Procedure.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "Procedure.contained",
"path" : "Procedure.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Procedure.extension",
"path" : "Procedure.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Procedure.modifierExtension",
"path" : "Procedure.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Procedure.identifier",
"path" : "Procedure.identifier",
"short" : "External Identifiers for this procedure",
"definition" : "Business identifiers assigned to this procedure by the performer or other systems which remain constant as the resource is updated and is propagated from server to server.",
"comment" : "This is a business identifier, not a resource identifier (see [discussion](resource.html#identifiers)). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and Person resource instances might share the same social insurance number.",
"requirements" : "Allows identification of the procedure as it is known by various participating systems and in a way that remains consistent across servers.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Procedure.identifier",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Identifier"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.identifier"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "v2",
"map" : "Some combination of ORC-2 / ORC-3 / OBR-2 / OBR-3 / IPC-1 / IPC-2 / IPC-3 / IPC-4"
},
{
"identity" : "rim",
"map" : ".id"
}]
},
{
"id" : "Procedure.instantiatesCanonical",
"path" : "Procedure.instantiatesCanonical",
"short" : "Instantiates FHIR protocol or definition",
"definition" : "The URL pointing to a FHIR-defined protocol, guideline, order set or other definition that is adhered to in whole or in part by this Procedure.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Procedure.instantiatesCanonical",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/PlanDefinition",
"http://hl7.org/fhir/StructureDefinition/ActivityDefinition",
"http://hl7.org/fhir/StructureDefinition/Measure",
"http://hl7.org/fhir/StructureDefinition/OperationDefinition",
"http://hl7.org/fhir/StructureDefinition/Questionnaire"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.instantiatesCanonical"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=DEFN].target"
}]
},
{
"id" : "Procedure.instantiatesUri",
"path" : "Procedure.instantiatesUri",
"short" : "Instantiates external protocol or definition",
"definition" : "The URL pointing to an externally maintained protocol, guideline, order set or other definition that is adhered to in whole or in part by this Procedure.",
"comment" : "This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Procedure.instantiatesUri",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.instantiatesUri"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=DEFN].target"
}]
},
{
"id" : "Procedure.basedOn",
"path" : "Procedure.basedOn",
"short" : "A request for this procedure",
"definition" : "A reference to a resource that contains details of the request for this procedure.",
"alias" : ["fulfills"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Procedure.basedOn",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/CarePlan",
"http://hl7.org/fhir/StructureDefinition/ServiceRequest"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.basedOn"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=FLFS].target[classCode=(various e.g. PROC, OBS, PCPR, ACT, moodCode=RQO].code"
}]
},
{
"id" : "Procedure.partOf",
"path" : "Procedure.partOf",
"short" : "Part of referenced event",
"definition" : "A larger event of which this particular procedure is a component or step.",
"comment" : "The MedicationAdministration resource has a partOf reference to Procedure, but this is not a circular reference. For example, the anesthesia MedicationAdministration is part of the surgical Procedure (MedicationAdministration.partOf = Procedure). For example, the procedure to insert the IV port for an IV medication administration is part of the medication administration (Procedure.partOf = MedicationAdministration).",
"alias" : ["container"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Procedure.partOf",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Procedure",
"http://hl7.org/fhir/StructureDefinition/Observation",
"http://hl7.org/fhir/StructureDefinition/MedicationAdministration"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.partOf"
},
{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=COMP].source[classCode=SBADM or PROC or OBS, moodCode=EVN]"
}]
},
{
"id" : "Procedure.status",
"path" : "Procedure.status",
"short" : "preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown",
"definition" : "A code specifying the state of the procedure. Generally, this will be the in-progress or completed state.",
"comment" : "The \"unknown\" code is not to be used to convey other statuses. The \"unknown\" code should be used when one of the statuses applies, but the authoring system doesn't know the current state of the procedure.\n\nThis element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Procedure.status",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ProcedureStatus"
}],
"strength" : "required",
"description" : "A code specifying the state of the procedure.",
"valueSet" : "http://hl7.org/fhir/ValueSet/event-status|4.0.1"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.status"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
},
{
"identity" : "rim",
"map" : "statusCode"
}]
},
{
"id" : "Procedure.statusReason",
"path" : "Procedure.statusReason",
"short" : "Reason for current status",
"definition" : "Captures the reason for the current state of the procedure.",
"comment" : "This is generally only used for \"exception\" statuses such as \"not-done\", \"suspended\" or \"aborted\". The reason for performing the event at all is captured in reasonCode, not here.",
"alias" : ["Suspended Reason",
"Cancelled Reason"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Procedure.statusReason",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ProcedureNegationReason"
}],
"strength" : "example",
"description" : "A code that identifies the reason a procedure was not performed.",
"valueSet" : "http://hl7.org/fhir/ValueSet/procedure-not-performed-reason"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.statusReason"
},
{
"identity" : "rim",
"map" : ".reason.Observation.value"
}]
},
{
"id" : "Procedure.category",
"path" : "Procedure.category",
"short" : "Classification of the procedure",
"definition" : "A code that classifies the procedure for searching, sorting and display purposes (e.g. \"Surgical Procedure\").",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Procedure.category",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ProcedureCategory"
}],
"strength" : "example",
"description" : "A code that classifies a procedure for searching, sorting and display purposes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/procedure-category"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.class"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=\"COMP].target[classCode=\"LIST\", moodCode=\"EVN\"].code"
}]
},
{
"id" : "Procedure.code",
"path" : "Procedure.code",
"short" : "Identification of the procedure",
"definition" : "The specific procedure that is performed. Use text if the exact nature of the procedure cannot be coded (e.g. \"Laparoscopic Appendectomy\").",
"requirements" : "0..1 to account for primarily narrative only resources.",
"alias" : ["type"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Procedure.code",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ProcedureCode"
}],
"strength" : "example",
"description" : "A code to identify a specific procedure .",
"valueSet" : "http://hl7.org/fhir/ValueSet/procedure-code"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.code"
},
{
"identity" : "w5",
"map" : "FiveWs.what[x]"
},
{
"identity" : "v2",
"map" : "OBR-44/OBR-45"
},
{
"identity" : "rim",
"map" : ".code"
}]
},
{
"id" : "Procedure.subject",
"path" : "Procedure.subject",
"short" : "Who the procedure was performed on",
"definition" : "The person, animal or group on which the procedure was performed.",
"alias" : ["patient"],
"min" : 1,
"max" : "1",
"base" : {
"path" : "Procedure.subject",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Group"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.subject"
},
{
"identity" : "w5",
"map" : "FiveWs.subject[x]"
},
{
"identity" : "v2",
"map" : "PID-3"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=SBJ].role"
},
{
"identity" : "w5",
"map" : "FiveWs.subject"
}]
},
{
"id" : "Procedure.encounter",
"path" : "Procedure.encounter",
"short" : "Encounter created as part of",
"definition" : "The Encounter during which this Procedure was created or performed or to which the creation of this record is tightly associated.",
"comment" : "This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Procedure.encounter",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Encounter"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.context"
},
{
"identity" : "w5",
"map" : "FiveWs.context"
},
{
"identity" : "v2",
"map" : "PV1-19"
},
{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN]"
}]
},
{
"id" : "Procedure.performed[x]",
"path" : "Procedure.performed[x]",
"short" : "When the procedure was performed",
"definition" : "Estimated or actual date, date-time, period, or age when the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.",
"comment" : "Age is generally used when the patient reports an age at which the procedure was performed. Range is generally used when the patient reports an age range when the procedure was performed, such as sometime between 20-25 years old. dateTime supports a range of precision due to some procedures being reported as past procedures that might not have millisecond precision while other procedures performed and documented during the encounter might have more precise UTC timestamps with timezone.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Procedure.performed[x]",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
},
{
"code" : "Period"
},
{
"code" : "string"
},
{
"code" : "Age"
},
{
"code" : "Range"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.occurrence[x]"
},
{
"identity" : "w5",
"map" : "FiveWs.done[x]"
},
{
"identity" : "v2",
"map" : "OBR-7"
},
{
"identity" : "rim",
"map" : ".effectiveTime"
}]
},
{
"id" : "Procedure.recorder",
"path" : "Procedure.recorder",
"short" : "Who recorded the procedure",
"definition" : "Individual who recorded the record and takes responsibility for its content.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Procedure.recorder",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson",
"http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.author"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=AUT].role"
}]
},
{
"id" : "Procedure.asserter",
"path" : "Procedure.asserter",
"short" : "Person who asserts this procedure",
"definition" : "Individual who is making the procedure statement.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Procedure.asserter",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson",
"http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.source"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=INF].role"
}]
},
{
"id" : "Procedure.performer",
"path" : "Procedure.performer",
"short" : "The people who performed the procedure",
"definition" : "Limited to \"real\" people rather than equipment.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Procedure.performer",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.performer"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=PRF]"
}]
},
{
"id" : "Procedure.performer.id",
"path" : "Procedure.performer.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Procedure.performer.extension",
"path" : "Procedure.performer.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Procedure.performer.modifierExtension",
"path" : "Procedure.performer.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Procedure.performer.function",
"path" : "Procedure.performer.function",
"short" : "Type of performance",
"definition" : "Distinguishes the type of involvement of the performer in the procedure. For example, surgeon, anaesthetist, endoscopist.",
"requirements" : "Allows disambiguation of the types of involvement of different performers.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Procedure.performer.function",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ProcedurePerformerRole"
}],
"strength" : "example",
"description" : "A code that identifies the role of a performer of the procedure.",
"valueSet" : "http://hl7.org/fhir/ValueSet/performer-role"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.performer.function"
},
{
"identity" : "v2",
"map" : "Some combination of STF-18 / PRA-3 / PRT-4 / ROL-3 / ORC-12 / OBR-16 / PV1-7 / PV1-8 / PV1-9 / PV1-17 / OBX-25"
},
{
"identity" : "rim",
"map" : ".functionCode"
}]
},
{
"id" : "Procedure.performer.actor",
"path" : "Procedure.performer.actor",
"short" : "The reference to the practitioner",
"definition" : "The practitioner who was involved in the procedure.",
"requirements" : "A reference to Device supports use cases, such as pacemakers.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Procedure.performer.actor",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Organization",
"http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson",
"http://hl7.org/fhir/StructureDefinition/Device"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.performer.actor"
},
{
"identity" : "w5",
"map" : "FiveWs.actor"
},
{
"identity" : "v2",
"map" : "ORC-19/PRT-5"
},
{
"identity" : "rim",
"map" : ".role"
}]
},
{
"id" : "Procedure.performer.onBehalfOf",
"path" : "Procedure.performer.onBehalfOf",
"short" : "Organization the device or practitioner was acting for",
"definition" : "The organization the device or practitioner was acting on behalf of.",
"requirements" : "Practitioners and Devices can be associated with multiple organizations. This element indicates which organization they were acting on behalf of when performing the action.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Procedure.performer.onBehalfOf",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".scoper"
}]
},
{
"id" : "Procedure.location",
"path" : "Procedure.location",
"short" : "Where the procedure happened",
"definition" : "The location where the procedure actually happened. E.g. a newborn at home, a tracheostomy at a restaurant.",
"requirements" : "Ties a procedure to where the records are likely kept.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Procedure.location",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Location"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.where[x]"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=LOC].role[classCode=SDLOC]"
}]
},
{
"id" : "Procedure.reasonCode",
"path" : "Procedure.reasonCode",
"short" : "Coded reason procedure performed",
"definition" : "The coded reason why the procedure was performed. This may be a coded entity of some type, or may simply be present as text.",
"comment" : "Use Procedure.reasonCode when a code sufficiently describes the reason. Use Procedure.reasonReference when referencing a resource, which allows more information to be conveyed, such as onset date. Procedure.reasonCode and Procedure.reasonReference are not meant to be duplicative. For a single reason, either Procedure.reasonCode or Procedure.reasonReference can be used. Procedure.reasonCode may be a summary code, or Procedure.reasonReference may be used to reference a very precise definition of the reason using Condition | Observation | Procedure | DiagnosticReport | DocumentReference. Both Procedure.reasonCode and Procedure.reasonReference can be used if they are describing different reasons for the procedure.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Procedure.reasonCode",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ProcedureReason"
}],
"strength" : "example",
"description" : "A code that identifies the reason a procedure is required.",
"valueSet" : "http://hl7.org/fhir/ValueSet/procedure-reason"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.reasonCode"
},
{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "rim",
"map" : ".reasonCode"
}]
},
{
"id" : "Procedure.reasonReference",
"path" : "Procedure.reasonReference",
"short" : "The justification that the procedure was performed",
"definition" : "The justification of why the procedure was performed.",
"comment" : "It is possible for a procedure to be a reason (such as C-Section) for another procedure (such as an epidural). Other examples include endoscopy for dilatation and biopsy (a combination of diagnostic and therapeutic use). \nUse Procedure.reasonCode when a code sufficiently describes the reason. Use Procedure.reasonReference when referencing a resource, which allows more information to be conveyed, such as onset date. Procedure.reasonCode and Procedure.reasonReference are not meant to be duplicative. For a single reason, either Procedure.reasonCode or Procedure.reasonReference can be used. Procedure.reasonCode may be a summary code, or Procedure.reasonReference may be used to reference a very precise definition of the reason using Condition | Observation | Procedure | DiagnosticReport | DocumentReference. Both Procedure.reasonCode and Procedure.reasonReference can be used if they are describing different reasons for the procedure.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Procedure.reasonReference",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Condition",
"http://hl7.org/fhir/StructureDefinition/Observation",
"http://hl7.org/fhir/StructureDefinition/Procedure",
"http://hl7.org/fhir/StructureDefinition/DiagnosticReport",
"http://hl7.org/fhir/StructureDefinition/DocumentReference"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.reasonReference"
},
{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "rim",
"map" : ".reasonCode"
}]
},
{
"id" : "Procedure.bodySite",
"path" : "Procedure.bodySite",
"short" : "Target body sites",
"definition" : "Detailed and structured anatomical location information. Multiple locations are allowed - e.g. multiple punch biopsies of a lesion.",
"comment" : "If the use case requires attributes from the BodySite resource (e.g. to identify and track separately) then use the standard extension [procedure-targetbodystructure](extension-procedure-targetbodystructure.html).",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Procedure.bodySite",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "BodySite"
}],
"strength" : "example",
"description" : "Codes describing anatomical locations. May include laterality.",
"valueSet" : "http://hl7.org/fhir/ValueSet/body-site"
},
"mapping" : [{
"identity" : "v2",
"map" : "OBX-20"
},
{
"identity" : "rim",
"map" : ".targetSiteCode"
}]
},
{
"id" : "Procedure.outcome",
"path" : "Procedure.outcome",
"short" : "The result of procedure",
"definition" : "The outcome of the procedure - did it resolve the reasons for the procedure being performed?",
"comment" : "If outcome contains narrative text only, it can be captured using the CodeableConcept.text.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Procedure.outcome",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ProcedureOutcome"
}],
"strength" : "example",
"description" : "An outcome of a procedure - whether it was resolved or otherwise.",
"valueSet" : "http://hl7.org/fhir/ValueSet/procedure-outcome"
},
"mapping" : [{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=OUT].target.text"
}]
},
{
"id" : "Procedure.report",
"path" : "Procedure.report",
"short" : "Any report resulting from the procedure",
"definition" : "This could be a histology result, pathology report, surgical report, etc.",
"comment" : "There could potentially be multiple reports - e.g. if this was a procedure which took multiple biopsies resulting in a number of anatomical pathology reports.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Procedure.report",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/DiagnosticReport",
"http://hl7.org/fhir/StructureDefinition/DocumentReference",
"http://hl7.org/fhir/StructureDefinition/Composition"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN]"
}]
},
{
"id" : "Procedure.complication",
"path" : "Procedure.complication",
"short" : "Complication following the procedure",
"definition" : "Any complications that occurred during the procedure, or in the immediate post-performance period. These are generally tracked separately from the notes, which will typically describe the procedure itself rather than any 'post procedure' issues.",
"comment" : "If complications are only expressed by the narrative text, they can be captured using the CodeableConcept.text.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Procedure.complication",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ProcedureComplication"
}],
"strength" : "example",
"description" : "Codes describing complications that resulted from a procedure.",
"valueSet" : "http://hl7.org/fhir/ValueSet/condition-code"
},
"mapping" : [{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=OUTC].target[classCode=OBS, code=\"complication\", moodCode=EVN].value"
}]
},
{
"id" : "Procedure.complicationDetail",
"path" : "Procedure.complicationDetail",
"short" : "A condition that is a result of the procedure",
"definition" : "Any complications that occurred during the procedure, or in the immediate post-performance period.",
"requirements" : "This is used to document a condition that is a result of the procedure, not the condition that was the reason for the procedure.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Procedure.complicationDetail",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Condition"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=OUTC].target[classCode=OBS, code=\"complication\", moodCode=EVN].value"
}]
},
{
"id" : "Procedure.followUp",
"path" : "Procedure.followUp",
"short" : "Instructions for follow up",
"definition" : "If the procedure required specific follow up - e.g. removal of sutures. The follow up may be represented as a simple note or could potentially be more complex, in which case the CarePlan resource can be used.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Procedure.followUp",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ProcedureFollowUp"
}],
"strength" : "example",
"description" : "Specific follow up required for a procedure e.g. removal of sutures.",
"valueSet" : "http://hl7.org/fhir/ValueSet/procedure-followup"
},
"mapping" : [{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=COMP].target[classCode=ACT, moodCode=INT].code"
}]
},
{
"id" : "Procedure.note",
"path" : "Procedure.note",
"short" : "Additional information about the procedure",
"definition" : "Any other notes and comments about the procedure.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Procedure.note",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Annotation"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.note"
},
{
"identity" : "v2",
"map" : "NTE"
},
{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"annotation\"].value"
}]
},
{
"id" : "Procedure.focalDevice",
"path" : "Procedure.focalDevice",
"short" : "Manipulated, implanted, or removed device",
"definition" : "A device that is implanted, removed or otherwise manipulated (calibration, battery replacement, fitting a prosthesis, attaching a wound-vac, etc.) as a focal portion of the Procedure.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Procedure.focalDevice",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".participation[typeCode=DEV].role[classCode=MANU]"
}]
},
{
"id" : "Procedure.focalDevice.id",
"path" : "Procedure.focalDevice.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Procedure.focalDevice.extension",
"path" : "Procedure.focalDevice.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Procedure.focalDevice.modifierExtension",
"path" : "Procedure.focalDevice.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Procedure.focalDevice.action",
"path" : "Procedure.focalDevice.action",
"short" : "Kind of change to device",
"definition" : "The kind of change that happened to the device during the procedure.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Procedure.focalDevice.action",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "DeviceActionKind"
}],
"strength" : "preferred",
"description" : "A kind of change that happened to the device during the procedure.",
"valueSet" : "http://hl7.org/fhir/ValueSet/device-action"
},
"mapping" : [{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"procedure device action\"].value=:procedure device action codes"
}]
},
{
"id" : "Procedure.focalDevice.manipulated",
"path" : "Procedure.focalDevice.manipulated",
"short" : "Device that was changed",
"definition" : "The device that was manipulated (changed) during the procedure.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Procedure.focalDevice.manipulated",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Device"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".participation[typeCode=DEV].role[classCode=SDLOC]"
}]
},
{
"id" : "Procedure.usedReference",
"path" : "Procedure.usedReference",
"short" : "Items used during procedure",
"definition" : "Identifies medications, devices and any other substance used as part of the procedure.",
"comment" : "For devices actually implanted or removed, use Procedure.device.",
"requirements" : "Used for tracking contamination, etc.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Procedure.usedReference",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Device",
"http://hl7.org/fhir/StructureDefinition/Medication",
"http://hl7.org/fhir/StructureDefinition/Substance"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".participation[typeCode=DEV].role[classCode=MANU] or\n.participation[typeCode=CSM].role[classCode=ADMM] (for Medication or Substance)"
}]
},
{
"id" : "Procedure.usedCode",
"path" : "Procedure.usedCode",
"short" : "Coded items used during the procedure",
"definition" : "Identifies coded items that were used as part of the procedure.",
"comment" : "For devices actually implanted or removed, use Procedure.device.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Procedure.usedCode",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ProcedureUsed"
}],
"strength" : "example",
"description" : "Codes describing items used during a procedure.",
"valueSet" : "http://hl7.org/fhir/ValueSet/device-kind"
},
"mapping" : [{
"identity" : "rim",
"map" : "participation[typeCode=Dev].role[classCode=MANU]"
}]
}]
},
"differential" : {
"element" : [{
"id" : "Procedure",
"path" : "Procedure",
"short" : "An action that is being or was performed on a patient",
"definition" : "An action that is or was performed on or for a patient. This can be a physical intervention like an operation, or less invasive like long term services, counseling, or hypnotherapy.",
"min" : 0,
"max" : "*",
"mapping" : [{
"identity" : "workflow",
"map" : "Event"
},
{
"identity" : "rim",
"map" : "Procedure[moodCode=EVN]"
}]
},
{
"id" : "Procedure.identifier",
"path" : "Procedure.identifier",
"short" : "External Identifiers for this procedure",
"definition" : "Business identifiers assigned to this procedure by the performer or other systems which remain constant as the resource is updated and is propagated from server to server.",
"comment" : "This is a business identifier, not a resource identifier (see [discussion](resource.html#identifiers)). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and Person resource instances might share the same social insurance number.",
"requirements" : "Allows identification of the procedure as it is known by various participating systems and in a way that remains consistent across servers.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Identifier"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.identifier"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "v2",
"map" : "Some combination of ORC-2 / ORC-3 / OBR-2 / OBR-3 / IPC-1 / IPC-2 / IPC-3 / IPC-4"
},
{
"identity" : "rim",
"map" : ".id"
}]
},
{
"id" : "Procedure.instantiatesCanonical",
"path" : "Procedure.instantiatesCanonical",
"short" : "Instantiates FHIR protocol or definition",
"definition" : "The URL pointing to a FHIR-defined protocol, guideline, order set or other definition that is adhered to in whole or in part by this Procedure.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/PlanDefinition",
"http://hl7.org/fhir/StructureDefinition/ActivityDefinition",
"http://hl7.org/fhir/StructureDefinition/Measure",
"http://hl7.org/fhir/StructureDefinition/OperationDefinition",
"http://hl7.org/fhir/StructureDefinition/Questionnaire"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.instantiatesCanonical"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=DEFN].target"
}]
},
{
"id" : "Procedure.instantiatesUri",
"path" : "Procedure.instantiatesUri",
"short" : "Instantiates external protocol or definition",
"definition" : "The URL pointing to an externally maintained protocol, guideline, order set or other definition that is adhered to in whole or in part by this Procedure.",
"comment" : "This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "uri"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.instantiatesUri"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=DEFN].target"
}]
},
{
"id" : "Procedure.basedOn",
"path" : "Procedure.basedOn",
"short" : "A request for this procedure",
"definition" : "A reference to a resource that contains details of the request for this procedure.",
"alias" : ["fulfills"],
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/CarePlan",
"http://hl7.org/fhir/StructureDefinition/ServiceRequest"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.basedOn"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=FLFS].target[classCode=(various e.g. PROC, OBS, PCPR, ACT, moodCode=RQO].code"
}]
},
{
"id" : "Procedure.partOf",
"path" : "Procedure.partOf",
"short" : "Part of referenced event",
"definition" : "A larger event of which this particular procedure is a component or step.",
"comment" : "The MedicationAdministration resource has a partOf reference to Procedure, but this is not a circular reference. For example, the anesthesia MedicationAdministration is part of the surgical Procedure (MedicationAdministration.partOf = Procedure). For example, the procedure to insert the IV port for an IV medication administration is part of the medication administration (Procedure.partOf = MedicationAdministration).",
"alias" : ["container"],
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Procedure",
"http://hl7.org/fhir/StructureDefinition/Observation",
"http://hl7.org/fhir/StructureDefinition/MedicationAdministration"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.partOf"
},
{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=COMP].source[classCode=SBADM or PROC or OBS, moodCode=EVN]"
}]
},
{
"id" : "Procedure.status",
"path" : "Procedure.status",
"short" : "preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown",
"definition" : "A code specifying the state of the procedure. Generally, this will be the in-progress or completed state.",
"comment" : "The \"unknown\" code is not to be used to convey other statuses. The \"unknown\" code should be used when one of the statuses applies, but the authoring system doesn't know the current state of the procedure.\n\nThis element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isModifier" : true,
"isModifierReason" : "This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ProcedureStatus"
}],
"strength" : "required",
"description" : "A code specifying the state of the procedure.",
"valueSet" : "http://hl7.org/fhir/ValueSet/event-status|4.0.1"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.status"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
},
{
"identity" : "rim",
"map" : "statusCode"
}]
},
{
"id" : "Procedure.statusReason",
"path" : "Procedure.statusReason",
"short" : "Reason for current status",
"definition" : "Captures the reason for the current state of the procedure.",
"comment" : "This is generally only used for \"exception\" statuses such as \"not-done\", \"suspended\" or \"aborted\". The reason for performing the event at all is captured in reasonCode, not here.",
"alias" : ["Suspended Reason",
"Cancelled Reason"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ProcedureNegationReason"
}],
"strength" : "example",
"description" : "A code that identifies the reason a procedure was not performed.",
"valueSet" : "http://hl7.org/fhir/ValueSet/procedure-not-performed-reason"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.statusReason"
},
{
"identity" : "rim",
"map" : ".reason.Observation.value"
}]
},
{
"id" : "Procedure.category",
"path" : "Procedure.category",
"short" : "Classification of the procedure",
"definition" : "A code that classifies the procedure for searching, sorting and display purposes (e.g. \"Surgical Procedure\").",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ProcedureCategory"
}],
"strength" : "example",
"description" : "A code that classifies a procedure for searching, sorting and display purposes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/procedure-category"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.class"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=\"COMP].target[classCode=\"LIST\", moodCode=\"EVN\"].code"
}]
},
{
"id" : "Procedure.code",
"path" : "Procedure.code",
"short" : "Identification of the procedure",
"definition" : "The specific procedure that is performed. Use text if the exact nature of the procedure cannot be coded (e.g. \"Laparoscopic Appendectomy\").",
"requirements" : "0..1 to account for primarily narrative only resources.",
"alias" : ["type"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ProcedureCode"
}],
"strength" : "example",
"description" : "A code to identify a specific procedure .",
"valueSet" : "http://hl7.org/fhir/ValueSet/procedure-code"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.code"
},
{
"identity" : "w5",
"map" : "FiveWs.what[x]"
},
{
"identity" : "v2",
"map" : "OBR-44/OBR-45"
},
{
"identity" : "rim",
"map" : ".code"
}]
},
{
"id" : "Procedure.subject",
"path" : "Procedure.subject",
"short" : "Who the procedure was performed on",
"definition" : "The person, animal or group on which the procedure was performed.",
"alias" : ["patient"],
"min" : 1,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Group"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.subject"
},
{
"identity" : "w5",
"map" : "FiveWs.subject[x]"
},
{
"identity" : "v2",
"map" : "PID-3"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=SBJ].role"
},
{
"identity" : "w5",
"map" : "FiveWs.subject"
}]
},
{
"id" : "Procedure.encounter",
"path" : "Procedure.encounter",
"short" : "Encounter created as part of",
"definition" : "The Encounter during which this Procedure was created or performed or to which the creation of this record is tightly associated.",
"comment" : "This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Encounter"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.context"
},
{
"identity" : "w5",
"map" : "FiveWs.context"
},
{
"identity" : "v2",
"map" : "PV1-19"
},
{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN]"
}]
},
{
"id" : "Procedure.performed[x]",
"path" : "Procedure.performed[x]",
"short" : "When the procedure was performed",
"definition" : "Estimated or actual date, date-time, period, or age when the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.",
"comment" : "Age is generally used when the patient reports an age at which the procedure was performed. Range is generally used when the patient reports an age range when the procedure was performed, such as sometime between 20-25 years old. dateTime supports a range of precision due to some procedures being reported as past procedures that might not have millisecond precision while other procedures performed and documented during the encounter might have more precise UTC timestamps with timezone.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "dateTime"
},
{
"code" : "Period"
},
{
"code" : "string"
},
{
"code" : "Age"
},
{
"code" : "Range"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.occurrence[x]"
},
{
"identity" : "w5",
"map" : "FiveWs.done[x]"
},
{
"identity" : "v2",
"map" : "OBR-7"
},
{
"identity" : "rim",
"map" : ".effectiveTime"
}]
},
{
"id" : "Procedure.recorder",
"path" : "Procedure.recorder",
"short" : "Who recorded the procedure",
"definition" : "Individual who recorded the record and takes responsibility for its content.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson",
"http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.author"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=AUT].role"
}]
},
{
"id" : "Procedure.asserter",
"path" : "Procedure.asserter",
"short" : "Person who asserts this procedure",
"definition" : "Individual who is making the procedure statement.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson",
"http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.source"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=INF].role"
}]
},
{
"id" : "Procedure.performer",
"path" : "Procedure.performer",
"short" : "The people who performed the procedure",
"definition" : "Limited to \"real\" people rather than equipment.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.performer"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=PRF]"
}]
},
{
"id" : "Procedure.performer.function",
"path" : "Procedure.performer.function",
"short" : "Type of performance",
"definition" : "Distinguishes the type of involvement of the performer in the procedure. For example, surgeon, anaesthetist, endoscopist.",
"requirements" : "Allows disambiguation of the types of involvement of different performers.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ProcedurePerformerRole"
}],
"strength" : "example",
"description" : "A code that identifies the role of a performer of the procedure.",
"valueSet" : "http://hl7.org/fhir/ValueSet/performer-role"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.performer.function"
},
{
"identity" : "v2",
"map" : "Some combination of STF-18 / PRA-3 / PRT-4 / ROL-3 / ORC-12 / OBR-16 / PV1-7 / PV1-8 / PV1-9 / PV1-17 / OBX-25"
},
{
"identity" : "rim",
"map" : ".functionCode"
}]
},
{
"id" : "Procedure.performer.actor",
"path" : "Procedure.performer.actor",
"short" : "The reference to the practitioner",
"definition" : "The practitioner who was involved in the procedure.",
"requirements" : "A reference to Device supports use cases, such as pacemakers.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Organization",
"http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson",
"http://hl7.org/fhir/StructureDefinition/Device"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.performer.actor"
},
{
"identity" : "w5",
"map" : "FiveWs.actor"
},
{
"identity" : "v2",
"map" : "ORC-19/PRT-5"
},
{
"identity" : "rim",
"map" : ".role"
}]
},
{
"id" : "Procedure.performer.onBehalfOf",
"path" : "Procedure.performer.onBehalfOf",
"short" : "Organization the device or practitioner was acting for",
"definition" : "The organization the device or practitioner was acting on behalf of.",
"requirements" : "Practitioners and Devices can be associated with multiple organizations. This element indicates which organization they were acting on behalf of when performing the action.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"mapping" : [{
"identity" : "rim",
"map" : ".scoper"
}]
},
{
"id" : "Procedure.location",
"path" : "Procedure.location",
"short" : "Where the procedure happened",
"definition" : "The location where the procedure actually happened. E.g. a newborn at home, a tracheostomy at a restaurant.",
"requirements" : "Ties a procedure to where the records are likely kept.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Location"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.where[x]"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=LOC].role[classCode=SDLOC]"
}]
},
{
"id" : "Procedure.reasonCode",
"path" : "Procedure.reasonCode",
"short" : "Coded reason procedure performed",
"definition" : "The coded reason why the procedure was performed. This may be a coded entity of some type, or may simply be present as text.",
"comment" : "Use Procedure.reasonCode when a code sufficiently describes the reason. Use Procedure.reasonReference when referencing a resource, which allows more information to be conveyed, such as onset date. Procedure.reasonCode and Procedure.reasonReference are not meant to be duplicative. For a single reason, either Procedure.reasonCode or Procedure.reasonReference can be used. Procedure.reasonCode may be a summary code, or Procedure.reasonReference may be used to reference a very precise definition of the reason using Condition | Observation | Procedure | DiagnosticReport | DocumentReference. Both Procedure.reasonCode and Procedure.reasonReference can be used if they are describing different reasons for the procedure.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ProcedureReason"
}],
"strength" : "example",
"description" : "A code that identifies the reason a procedure is required.",
"valueSet" : "http://hl7.org/fhir/ValueSet/procedure-reason"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.reasonCode"
},
{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "rim",
"map" : ".reasonCode"
}]
},
{
"id" : "Procedure.reasonReference",
"path" : "Procedure.reasonReference",
"short" : "The justification that the procedure was performed",
"definition" : "The justification of why the procedure was performed.",
"comment" : "It is possible for a procedure to be a reason (such as C-Section) for another procedure (such as an epidural). Other examples include endoscopy for dilatation and biopsy (a combination of diagnostic and therapeutic use). \nUse Procedure.reasonCode when a code sufficiently describes the reason. Use Procedure.reasonReference when referencing a resource, which allows more information to be conveyed, such as onset date. Procedure.reasonCode and Procedure.reasonReference are not meant to be duplicative. For a single reason, either Procedure.reasonCode or Procedure.reasonReference can be used. Procedure.reasonCode may be a summary code, or Procedure.reasonReference may be used to reference a very precise definition of the reason using Condition | Observation | Procedure | DiagnosticReport | DocumentReference. Both Procedure.reasonCode and Procedure.reasonReference can be used if they are describing different reasons for the procedure.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Condition",
"http://hl7.org/fhir/StructureDefinition/Observation",
"http://hl7.org/fhir/StructureDefinition/Procedure",
"http://hl7.org/fhir/StructureDefinition/DiagnosticReport",
"http://hl7.org/fhir/StructureDefinition/DocumentReference"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.reasonReference"
},
{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "rim",
"map" : ".reasonCode"
}]
},
{
"id" : "Procedure.bodySite",
"path" : "Procedure.bodySite",
"short" : "Target body sites",
"definition" : "Detailed and structured anatomical location information. Multiple locations are allowed - e.g. multiple punch biopsies of a lesion.",
"comment" : "If the use case requires attributes from the BodySite resource (e.g. to identify and track separately) then use the standard extension [procedure-targetbodystructure](extension-procedure-targetbodystructure.html).",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "BodySite"
}],
"strength" : "example",
"description" : "Codes describing anatomical locations. May include laterality.",
"valueSet" : "http://hl7.org/fhir/ValueSet/body-site"
},
"mapping" : [{
"identity" : "v2",
"map" : "OBX-20"
},
{
"identity" : "rim",
"map" : ".targetSiteCode"
}]
},
{
"id" : "Procedure.outcome",
"path" : "Procedure.outcome",
"short" : "The result of procedure",
"definition" : "The outcome of the procedure - did it resolve the reasons for the procedure being performed?",
"comment" : "If outcome contains narrative text only, it can be captured using the CodeableConcept.text.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ProcedureOutcome"
}],
"strength" : "example",
"description" : "An outcome of a procedure - whether it was resolved or otherwise.",
"valueSet" : "http://hl7.org/fhir/ValueSet/procedure-outcome"
},
"mapping" : [{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=OUT].target.text"
}]
},
{
"id" : "Procedure.report",
"path" : "Procedure.report",
"short" : "Any report resulting from the procedure",
"definition" : "This could be a histology result, pathology report, surgical report, etc.",
"comment" : "There could potentially be multiple reports - e.g. if this was a procedure which took multiple biopsies resulting in a number of anatomical pathology reports.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/DiagnosticReport",
"http://hl7.org/fhir/StructureDefinition/DocumentReference",
"http://hl7.org/fhir/StructureDefinition/Composition"]
}],
"mapping" : [{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN]"
}]
},
{
"id" : "Procedure.complication",
"path" : "Procedure.complication",
"short" : "Complication following the procedure",
"definition" : "Any complications that occurred during the procedure, or in the immediate post-performance period. These are generally tracked separately from the notes, which will typically describe the procedure itself rather than any 'post procedure' issues.",
"comment" : "If complications are only expressed by the narrative text, they can be captured using the CodeableConcept.text.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ProcedureComplication"
}],
"strength" : "example",
"description" : "Codes describing complications that resulted from a procedure.",
"valueSet" : "http://hl7.org/fhir/ValueSet/condition-code"
},
"mapping" : [{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=OUTC].target[classCode=OBS, code=\"complication\", moodCode=EVN].value"
}]
},
{
"id" : "Procedure.complicationDetail",
"path" : "Procedure.complicationDetail",
"short" : "A condition that is a result of the procedure",
"definition" : "Any complications that occurred during the procedure, or in the immediate post-performance period.",
"requirements" : "This is used to document a condition that is a result of the procedure, not the condition that was the reason for the procedure.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Condition"]
}],
"mapping" : [{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=OUTC].target[classCode=OBS, code=\"complication\", moodCode=EVN].value"
}]
},
{
"id" : "Procedure.followUp",
"path" : "Procedure.followUp",
"short" : "Instructions for follow up",
"definition" : "If the procedure required specific follow up - e.g. removal of sutures. The follow up may be represented as a simple note or could potentially be more complex, in which case the CarePlan resource can be used.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ProcedureFollowUp"
}],
"strength" : "example",
"description" : "Specific follow up required for a procedure e.g. removal of sutures.",
"valueSet" : "http://hl7.org/fhir/ValueSet/procedure-followup"
},
"mapping" : [{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=COMP].target[classCode=ACT, moodCode=INT].code"
}]
},
{
"id" : "Procedure.note",
"path" : "Procedure.note",
"short" : "Additional information about the procedure",
"definition" : "Any other notes and comments about the procedure.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Annotation"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Event.note"
},
{
"identity" : "v2",
"map" : "NTE"
},
{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"annotation\"].value"
}]
},
{
"id" : "Procedure.focalDevice",
"path" : "Procedure.focalDevice",
"short" : "Manipulated, implanted, or removed device",
"definition" : "A device that is implanted, removed or otherwise manipulated (calibration, battery replacement, fitting a prosthesis, attaching a wound-vac, etc.) as a focal portion of the Procedure.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"mapping" : [{
"identity" : "rim",
"map" : ".participation[typeCode=DEV].role[classCode=MANU]"
}]
},
{
"id" : "Procedure.focalDevice.action",
"path" : "Procedure.focalDevice.action",
"short" : "Kind of change to device",
"definition" : "The kind of change that happened to the device during the procedure.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "DeviceActionKind"
}],
"strength" : "preferred",
"description" : "A kind of change that happened to the device during the procedure.",
"valueSet" : "http://hl7.org/fhir/ValueSet/device-action"
},
"mapping" : [{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"procedure device action\"].value=:procedure device action codes"
}]
},
{
"id" : "Procedure.focalDevice.manipulated",
"path" : "Procedure.focalDevice.manipulated",
"short" : "Device that was changed",
"definition" : "The device that was manipulated (changed) during the procedure.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Device"]
}],
"mapping" : [{
"identity" : "rim",
"map" : ".participation[typeCode=DEV].role[classCode=SDLOC]"
}]
},
{
"id" : "Procedure.usedReference",
"path" : "Procedure.usedReference",
"short" : "Items used during procedure",
"definition" : "Identifies medications, devices and any other substance used as part of the procedure.",
"comment" : "For devices actually implanted or removed, use Procedure.device.",
"requirements" : "Used for tracking contamination, etc.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Device",
"http://hl7.org/fhir/StructureDefinition/Medication",
"http://hl7.org/fhir/StructureDefinition/Substance"]
}],
"mapping" : [{
"identity" : "rim",
"map" : ".participation[typeCode=DEV].role[classCode=MANU] or\n.participation[typeCode=CSM].role[classCode=ADMM] (for Medication or Substance)"
}]
},
{
"id" : "Procedure.usedCode",
"path" : "Procedure.usedCode",
"short" : "Coded items used during the procedure",
"definition" : "Identifies coded items that were used as part of the procedure.",
"comment" : "For devices actually implanted or removed, use Procedure.device.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ProcedureUsed"
}],
"strength" : "example",
"description" : "Codes describing items used during a procedure.",
"valueSet" : "http://hl7.org/fhir/ValueSet/device-kind"
},
"mapping" : [{
"identity" : "rim",
"map" : "participation[typeCode=Dev].role[classCode=MANU]"
}]
}]
}
}
},
{
"fullUrl" : "http://hl7.org/fhir/StructureDefinition/Provenance",
"resource" : {
"resourceType" : "StructureDefinition",
"id" : "Provenance",
"meta" : {
"lastUpdated" : "2019-11-01T09:29:23.356+11:00"
},
"text" : {
"status" : "generated",
"div" : "Name Flags Card. Type Description & Constraints Provenance TU DomainResource Who, What, When for a set of resources
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension target Σ 1..* Reference(Any) Target Reference(s) (usually version specific)
occurred[x] 0..1 When the activity occurred occurredPeriod Period occurredDateTime dateTime recorded Σ 1..1 instant When the activity was recorded / updated policy 0..* uri Policy or plan the activity was defined by
location 0..1 Reference(Location) Where the activity occurred, if relevant reason 0..* CodeableConcept Reason the activity is occurring
V3 Value SetPurposeOfUse (Extensible)
activity 0..1 CodeableConcept Activity that occurred
Provenance activity type (Extensible) agent 1..* BackboneElement Actor involved
type Σ 0..1 CodeableConcept How the agent participated
Provenance participant type (Extensible) role 0..* CodeableConcept What the agents role was
SecurityRoleType (Example)
who Σ 1..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) Who participated onBehalfOf 0..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) Who the agent is representing entity 0..* BackboneElement An entity used in this activity
role Σ 1..1 code derivation | revision | quotation | source | removal
ProvenanceEntityRole (Required) what Σ 1..1 Reference(Any) Identity of entity agent 0..* see agent Entity is attributed to this agent
signature 0..* Signature Signature on target
Documentation for this format
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Foundation.Security"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 3
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "not-classified"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "sec"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/Provenance",
"version" : "4.0.1",
"name" : "Provenance",
"status" : "draft",
"date" : "2019-11-01T09:29:23+11:00",
"publisher" : "Health Level Seven International (Security)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/secure/index.cfm"
}]
}],
"description" : "Provenance of a resource is a record that describes entities and processes involved in producing and delivering or otherwise influencing that resource. Provenance provides a critical foundation for assessing authenticity, enabling trust, and allowing reproducibility. Provenance assertions are a form of contextual metadata and can themselves become important records with their own provenance. Provenance statement indicates clinical significance in terms of confidence in authenticity, reliability, and trustworthiness, integrity, and stage in lifecycle (e.g. Document Completion - has the artifact been legally authenticated), all of which may impact security, privacy, and trust policies.",
"fhirVersion" : "4.0.1",
"mapping" : [{
"identity" : "workflow",
"uri" : "http://hl7.org/fhir/workflow",
"name" : "Workflow Pattern"
},
{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
},
{
"identity" : "w3c.prov",
"uri" : "http://www.w3.org/ns/prov",
"name" : "W3C PROV"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/fivews",
"name" : "FiveWs Pattern Mapping"
},
{
"identity" : "fhirauditevent",
"uri" : "http://hl7.org/fhir/auditevent",
"name" : "FHIR AuditEvent Mapping"
}],
"kind" : "resource",
"abstract" : false,
"type" : "Provenance",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "Provenance",
"path" : "Provenance",
"short" : "Who, What, When for a set of resources",
"definition" : "Provenance of a resource is a record that describes entities and processes involved in producing and delivering or otherwise influencing that resource. Provenance provides a critical foundation for assessing authenticity, enabling trust, and allowing reproducibility. Provenance assertions are a form of contextual metadata and can themselves become important records with their own provenance. Provenance statement indicates clinical significance in terms of confidence in authenticity, reliability, and trustworthiness, integrity, and stage in lifecycle (e.g. Document Completion - has the artifact been legally authenticated), all of which may impact security, privacy, and trust policies.",
"comment" : "Some parties may be duplicated between the target resource and its provenance. For instance, the prescriber is usually (but not always) the author of the prescription resource. This resource is defined with close consideration for W3C Provenance.",
"alias" : ["History",
"Event",
"Activity"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Provenance",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "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",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.`div`.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "workflow",
"map" : "Event"
},
{
"identity" : "rim",
"map" : "ControlAct[isNormalAct() and subsumes(CACT, classCode) and moodCode=EVN]"
},
{
"identity" : "w3c.prov",
"map" : "Activity"
}]
},
{
"id" : "Provenance.id",
"path" : "Provenance.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Provenance.meta",
"path" : "Provenance.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Provenance.implicitRules",
"path" : "Provenance.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "Provenance.language",
"path" : "Provenance.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "Provenance.text",
"path" : "Provenance.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "Provenance.contained",
"path" : "Provenance.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Provenance.extension",
"path" : "Provenance.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Provenance.modifierExtension",
"path" : "Provenance.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Provenance.target",
"path" : "Provenance.target",
"short" : "Target Reference(s) (usually version specific)",
"definition" : "The Reference(s) that were generated or updated by the activity described in this resource. A provenance can point to more than one target if multiple resources were created/updated by the same activity.",
"comment" : "Target references are usually version specific, but might not be, if a version has not been assigned or if the provenance information is part of the set of resources being maintained (i.e. a document). When using the RESTful API, the identity of the resource might not be known (especially not the version specific one); the client may either submit the resource first, and then the provenance, or it may submit both using a single transaction. See the notes on transaction for further discussion.",
"min" : 1,
"max" : "*",
"base" : {
"path" : "Provenance.target",
"min" : 1,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.what[x]"
},
{
"identity" : "rim",
"map" : "./outboundRelationship[isNormalActRelationship() and typeCode=SUBJ]/target OR ./participation[isNormalParticipation() and typeCode=SBJ]/role OR ./participation[isNormalParticipation() and typeCode=SBJ]/role[isNormalRole()]/player"
},
{
"identity" : "fhirauditevent",
"map" : "AuditEvent.entity.reference"
},
{
"identity" : "w3c.prov",
"map" : "Entity Created/Updated"
}]
},
{
"id" : "Provenance.occurred[x]",
"path" : "Provenance.occurred[x]",
"short" : "When the activity occurred",
"definition" : "The period during which the activity occurred.",
"comment" : "The period can be a little arbitrary; where possible, the time should correspond to human assessment of the activity time.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Provenance.occurred[x]",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Period"
},
{
"code" : "dateTime"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.occurred[x]"
},
{
"identity" : "w5",
"map" : "FiveWs.done[x]"
},
{
"identity" : "rim",
"map" : "./effectiveTime[type=IVL_TS]"
},
{
"identity" : "w3c.prov",
"map" : "Activity.startTime & Activity.endTime"
}]
},
{
"id" : "Provenance.recorded",
"path" : "Provenance.recorded",
"short" : "When the activity was recorded / updated",
"definition" : "The instant of time at which the activity was recorded.",
"comment" : "This can be a little different from the time stamp on the resource if there is a delay between recording the event and updating the provenance and target resource.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Provenance.recorded",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "instant"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.recorded"
},
{
"identity" : "rim",
"map" : "unique(./participation[isNormalParticipation() and typeCode=AUT]/time[type=TS])"
},
{
"identity" : "fhirauditevent",
"map" : "AuditEvent.recorded"
},
{
"identity" : "w3c.prov",
"map" : "Activity.when"
}]
},
{
"id" : "Provenance.policy",
"path" : "Provenance.policy",
"short" : "Policy or plan the activity was defined by",
"definition" : "Policy or plan the activity was defined by. Typically, a single activity may have multiple applicable policy documents, such as patient consent, guarantor funding, etc.",
"comment" : "For example: Where an OAuth token authorizes, the unique identifier from the OAuth token is placed into the policy element Where a policy engine (e.g. XACML) holds policy logic, the unique policy identifier is placed into the policy element.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Provenance.policy",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "./inboundRelationship[isNormalActRelationship() and typeCode=\"SUBJ\"]/source[isNormalAct and subsumes(POLICY, classCode) and moodCode=EVN]/text[typeCode='ED'/tel"
},
{
"identity" : "fhirauditevent",
"map" : "AuditEvent.agent.policy"
}]
},
{
"id" : "Provenance.location",
"path" : "Provenance.location",
"short" : "Where the activity occurred, if relevant",
"definition" : "Where the activity occurred, if relevant.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Provenance.location",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Location"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.location"
},
{
"identity" : "w5",
"map" : "FiveWs.where[x]"
},
{
"identity" : "rim",
"map" : "unique(./participation[isNormalParticipation() and typeCode=LOC]/role[isNormalRole() and subsumes(SDLOC, classCode)]/player[isNormalEntity and classCode=\"LOC\" and determinerCode=\"INST\"]"
},
{
"identity" : "fhirauditevent",
"map" : "AuditEvent.agent.location"
},
{
"identity" : "w3c.prov",
"map" : "Activity.location"
}]
},
{
"id" : "Provenance.reason",
"path" : "Provenance.reason",
"short" : "Reason the activity is occurring",
"definition" : "The reason that the activity was taking place.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Provenance.reason",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ProvenanceReason"
}],
"strength" : "extensible",
"description" : "The reason the activity took place.",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-PurposeOfUse"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.reasonCode"
},
{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "rim",
"map" : "unique(./reasonCode)"
},
{
"identity" : "fhirauditevent",
"map" : "AuditEvent.purposeOfEvent"
},
{
"identity" : "w3c.prov",
"map" : "Activity.Activity"
}]
},
{
"id" : "Provenance.activity",
"path" : "Provenance.activity",
"short" : "Activity that occurred",
"definition" : "An activity is something that occurs over a period of time and acts upon or with entities; it may include consuming, processing, transforming, modifying, relocating, using, or generating entities.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Provenance.activity",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ProvenanceActivity"
}],
"strength" : "extensible",
"description" : "The activity that took place.",
"valueSet" : "http://hl7.org/fhir/ValueSet/provenance-activity-type"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.code"
},
{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "rim",
"map" : "Act.code"
},
{
"identity" : "w3c.prov",
"map" : "Activity.Activity"
}]
},
{
"id" : "Provenance.agent",
"path" : "Provenance.agent",
"short" : "Actor involved",
"definition" : "An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place.",
"comment" : "Several agents may be associated (i.e. has some responsibility for an activity) with an activity and vice-versa.",
"requirements" : "An agent can be a person, an organization, software, device, or other entities that may be ascribed responsibility.",
"min" : 1,
"max" : "*",
"base" : {
"path" : "Provenance.agent",
"min" : 1,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.performer"
},
{
"identity" : "w5",
"map" : "FiveWs.who"
},
{
"identity" : "rim",
"map" : "./participation[isNormalParticipation()] OR ./outboundRelationship[isNormalActRelationship() and typeCode='DRIV']"
},
{
"identity" : "fhirauditevent",
"map" : "AuditEvent.agent"
},
{
"identity" : "w3c.prov",
"map" : "Agent"
}]
},
{
"id" : "Provenance.agent.id",
"path" : "Provenance.agent.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Provenance.agent.extension",
"path" : "Provenance.agent.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Provenance.agent.modifierExtension",
"path" : "Provenance.agent.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Provenance.agent.type",
"path" : "Provenance.agent.type",
"short" : "How the agent participated",
"definition" : "The participation the agent had with respect to the activity.",
"comment" : "For example: author, performer, enterer, attester, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Provenance.agent.type",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ProvenanceAgentType"
}],
"strength" : "extensible",
"description" : "The type of participation that a provenance agent played with respect to the activity.",
"valueSet" : "http://hl7.org/fhir/ValueSet/provenance-agent-type"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.performer.function"
},
{
"identity" : "rim",
"map" : ".role"
},
{
"identity" : "fhirauditevent",
"map" : "AuditEvent.agent.type"
},
{
"identity" : "w3c.prov",
"map" : "Agent.Attribution"
}]
},
{
"id" : "Provenance.agent.role",
"path" : "Provenance.agent.role",
"short" : "What the agents role was",
"definition" : "The function of the agent with respect to the activity. The security role enabling the agent with respect to the activity.",
"comment" : "For example: doctor, nurse, clerk, etc.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Provenance.agent.role",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ProvenanceAgentRole"
}],
"strength" : "example",
"description" : "The role that a provenance agent played with respect to the activity.",
"valueSet" : "http://hl7.org/fhir/ValueSet/security-role-type"
},
"mapping" : [{
"identity" : "rim",
"map" : ".typecode"
},
{
"identity" : "fhirauditevent",
"map" : "AuditEvent.agent.role"
}]
},
{
"id" : "Provenance.agent.who",
"path" : "Provenance.agent.who",
"short" : "Who participated",
"definition" : "The individual, device or organization that participated in the event.",
"comment" : "whoIdentity should be used when the agent is not a Resource type.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Provenance.agent.who",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson",
"http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Device",
"http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.performer.actor"
},
{
"identity" : "w5",
"map" : "FiveWs.actor"
},
{
"identity" : "rim",
"map" : ".id"
}]
},
{
"id" : "Provenance.agent.onBehalfOf",
"path" : "Provenance.agent.onBehalfOf",
"short" : "Who the agent is representing",
"definition" : "The individual, device, or organization for whom the change was made.",
"comment" : "onBehalfOfIdentity should be used when the agent is not a Resource type.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Provenance.agent.onBehalfOf",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson",
"http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Device",
"http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Person, Practitioner, Organization, Device :* .role [classCode = RoleClassMutualRelationship; role.code and * .scopes[Role](classCode=IDENT) and *.plays [Role.Code]"
}]
},
{
"id" : "Provenance.entity",
"path" : "Provenance.entity",
"short" : "An entity used in this activity",
"definition" : "An entity used in this activity.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Provenance.entity",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "./subjectOf"
},
{
"identity" : "fhirauditevent",
"map" : "AuditEvent.entity"
},
{
"identity" : "w3c.prov",
"map" : "Entity"
}]
},
{
"id" : "Provenance.entity.id",
"path" : "Provenance.entity.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Provenance.entity.extension",
"path" : "Provenance.entity.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Provenance.entity.modifierExtension",
"path" : "Provenance.entity.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Provenance.entity.role",
"path" : "Provenance.entity.role",
"short" : "derivation | revision | quotation | source | removal",
"definition" : "How the entity was used during the activity.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Provenance.entity.role",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ProvenanceEntityRole"
}],
"strength" : "required",
"description" : "How an entity was used in an activity.",
"valueSet" : "http://hl7.org/fhir/ValueSet/provenance-entity-role|4.0.1"
},
"mapping" : [{
"identity" : "rim",
"map" : "./typeCode"
},
{
"identity" : "fhirauditevent",
"map" : "AuditEvent.entity.lifecycle"
},
{
"identity" : "w3c.prov",
"map" : "Entity.role"
}]
},
{
"id" : "Provenance.entity.what",
"path" : "Provenance.entity.what",
"short" : "Identity of entity",
"definition" : "Identity of the Entity used. May be a logical or physical uri and maybe absolute or relative.",
"comment" : "whatIdentity should be used for entities that are not a Resource type.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Provenance.entity.what",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "./text/reference"
},
{
"identity" : "fhirauditevent",
"map" : "AuditEvent.entity.reference"
},
{
"identity" : "w3c.prov",
"map" : "Entity.Identity"
}]
},
{
"id" : "Provenance.entity.agent",
"path" : "Provenance.entity.agent",
"short" : "Entity is attributed to this agent",
"definition" : "The entity is attributed to an agent to express the agent's responsibility for that entity, possibly along with other agents. This description can be understood as shorthand for saying that the agent was responsible for the activity which generated the entity.",
"comment" : "A usecase where one Provenance.entity.agent is used where the Entity that was used in the creation/updating of the Target, is not in the context of the same custodianship as the Target, and thus the meaning of Provenance.entity.agent is to say that the entity referenced is managed elsewhere and that this Agent provided access to it. This would be similar to where the Entity being referenced is managed outside FHIR, such as through HL7 v2, v3, or XDS. This might be where the Entity being referenced is managed in another FHIR resource server. Thus it explains the Provenance of that Entity's use in the context of this Provenance activity.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Provenance.entity.agent",
"min" : 0,
"max" : "*"
},
"contentReference" : "#Provenance.agent",
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "./author/role"
}]
},
{
"id" : "Provenance.signature",
"path" : "Provenance.signature",
"short" : "Signature on target",
"definition" : "A digital signature on the target Reference(s). The signer should match a Provenance.agent. The purpose of the signature is indicated.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Provenance.signature",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Signature"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "./signatureText"
}]
}]
},
"differential" : {
"element" : [{
"id" : "Provenance",
"path" : "Provenance",
"short" : "Who, What, When for a set of resources",
"definition" : "Provenance of a resource is a record that describes entities and processes involved in producing and delivering or otherwise influencing that resource. Provenance provides a critical foundation for assessing authenticity, enabling trust, and allowing reproducibility. Provenance assertions are a form of contextual metadata and can themselves become important records with their own provenance. Provenance statement indicates clinical significance in terms of confidence in authenticity, reliability, and trustworthiness, integrity, and stage in lifecycle (e.g. Document Completion - has the artifact been legally authenticated), all of which may impact security, privacy, and trust policies.",
"comment" : "Some parties may be duplicated between the target resource and its provenance. For instance, the prescriber is usually (but not always) the author of the prescription resource. This resource is defined with close consideration for W3C Provenance.",
"alias" : ["History",
"Event",
"Activity"],
"min" : 0,
"max" : "*",
"mapping" : [{
"identity" : "workflow",
"map" : "Event"
},
{
"identity" : "rim",
"map" : "ControlAct[isNormalAct() and subsumes(CACT, classCode) and moodCode=EVN]"
},
{
"identity" : "w3c.prov",
"map" : "Activity"
}]
},
{
"id" : "Provenance.target",
"path" : "Provenance.target",
"short" : "Target Reference(s) (usually version specific)",
"definition" : "The Reference(s) that were generated or updated by the activity described in this resource. A provenance can point to more than one target if multiple resources were created/updated by the same activity.",
"comment" : "Target references are usually version specific, but might not be, if a version has not been assigned or if the provenance information is part of the set of resources being maintained (i.e. a document). When using the RESTful API, the identity of the resource might not be known (especially not the version specific one); the client may either submit the resource first, and then the provenance, or it may submit both using a single transaction. See the notes on transaction for further discussion.",
"min" : 1,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.what[x]"
},
{
"identity" : "rim",
"map" : "./outboundRelationship[isNormalActRelationship() and typeCode=SUBJ]/target OR ./participation[isNormalParticipation() and typeCode=SBJ]/role OR ./participation[isNormalParticipation() and typeCode=SBJ]/role[isNormalRole()]/player"
},
{
"identity" : "fhirauditevent",
"map" : "AuditEvent.entity.reference"
},
{
"identity" : "w3c.prov",
"map" : "Entity Created/Updated"
}]
},
{
"id" : "Provenance.occurred[x]",
"path" : "Provenance.occurred[x]",
"short" : "When the activity occurred",
"definition" : "The period during which the activity occurred.",
"comment" : "The period can be a little arbitrary; where possible, the time should correspond to human assessment of the activity time.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Period"
},
{
"code" : "dateTime"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Event.occurred[x]"
},
{
"identity" : "w5",
"map" : "FiveWs.done[x]"
},
{
"identity" : "rim",
"map" : "./effectiveTime[type=IVL_TS]"
},
{
"identity" : "w3c.prov",
"map" : "Activity.startTime & Activity.endTime"
}]
},
{
"id" : "Provenance.recorded",
"path" : "Provenance.recorded",
"short" : "When the activity was recorded / updated",
"definition" : "The instant of time at which the activity was recorded.",
"comment" : "This can be a little different from the time stamp on the resource if there is a delay between recording the event and updating the provenance and target resource.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "instant"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.recorded"
},
{
"identity" : "rim",
"map" : "unique(./participation[isNormalParticipation() and typeCode=AUT]/time[type=TS])"
},
{
"identity" : "fhirauditevent",
"map" : "AuditEvent.recorded"
},
{
"identity" : "w3c.prov",
"map" : "Activity.when"
}]
},
{
"id" : "Provenance.policy",
"path" : "Provenance.policy",
"short" : "Policy or plan the activity was defined by",
"definition" : "Policy or plan the activity was defined by. Typically, a single activity may have multiple applicable policy documents, such as patient consent, guarantor funding, etc.",
"comment" : "For example: Where an OAuth token authorizes, the unique identifier from the OAuth token is placed into the policy element Where a policy engine (e.g. XACML) holds policy logic, the unique policy identifier is placed into the policy element.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "uri"
}],
"mapping" : [{
"identity" : "rim",
"map" : "./inboundRelationship[isNormalActRelationship() and typeCode=\"SUBJ\"]/source[isNormalAct and subsumes(POLICY, classCode) and moodCode=EVN]/text[typeCode='ED'/tel"
},
{
"identity" : "fhirauditevent",
"map" : "AuditEvent.agent.policy"
}]
},
{
"id" : "Provenance.location",
"path" : "Provenance.location",
"short" : "Where the activity occurred, if relevant",
"definition" : "Where the activity occurred, if relevant.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Location"]
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Event.location"
},
{
"identity" : "w5",
"map" : "FiveWs.where[x]"
},
{
"identity" : "rim",
"map" : "unique(./participation[isNormalParticipation() and typeCode=LOC]/role[isNormalRole() and subsumes(SDLOC, classCode)]/player[isNormalEntity and classCode=\"LOC\" and determinerCode=\"INST\"]"
},
{
"identity" : "fhirauditevent",
"map" : "AuditEvent.agent.location"
},
{
"identity" : "w3c.prov",
"map" : "Activity.location"
}]
},
{
"id" : "Provenance.reason",
"path" : "Provenance.reason",
"short" : "Reason the activity is occurring",
"definition" : "The reason that the activity was taking place.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ProvenanceReason"
}],
"strength" : "extensible",
"description" : "The reason the activity took place.",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-PurposeOfUse"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.reasonCode"
},
{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "rim",
"map" : "unique(./reasonCode)"
},
{
"identity" : "fhirauditevent",
"map" : "AuditEvent.purposeOfEvent"
},
{
"identity" : "w3c.prov",
"map" : "Activity.Activity"
}]
},
{
"id" : "Provenance.activity",
"path" : "Provenance.activity",
"short" : "Activity that occurred",
"definition" : "An activity is something that occurs over a period of time and acts upon or with entities; it may include consuming, processing, transforming, modifying, relocating, using, or generating entities.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ProvenanceActivity"
}],
"strength" : "extensible",
"description" : "The activity that took place.",
"valueSet" : "http://hl7.org/fhir/ValueSet/provenance-activity-type"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.code"
},
{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "rim",
"map" : "Act.code"
},
{
"identity" : "w3c.prov",
"map" : "Activity.Activity"
}]
},
{
"id" : "Provenance.agent",
"path" : "Provenance.agent",
"short" : "Actor involved",
"definition" : "An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place.",
"comment" : "Several agents may be associated (i.e. has some responsibility for an activity) with an activity and vice-versa.",
"requirements" : "An agent can be a person, an organization, software, device, or other entities that may be ascribed responsibility.",
"min" : 1,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Event.performer"
},
{
"identity" : "w5",
"map" : "FiveWs.who"
},
{
"identity" : "rim",
"map" : "./participation[isNormalParticipation()] OR ./outboundRelationship[isNormalActRelationship() and typeCode='DRIV']"
},
{
"identity" : "fhirauditevent",
"map" : "AuditEvent.agent"
},
{
"identity" : "w3c.prov",
"map" : "Agent"
}]
},
{
"id" : "Provenance.agent.type",
"path" : "Provenance.agent.type",
"short" : "How the agent participated",
"definition" : "The participation the agent had with respect to the activity.",
"comment" : "For example: author, performer, enterer, attester, etc.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ProvenanceAgentType"
}],
"strength" : "extensible",
"description" : "The type of participation that a provenance agent played with respect to the activity.",
"valueSet" : "http://hl7.org/fhir/ValueSet/provenance-agent-type"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.performer.function"
},
{
"identity" : "rim",
"map" : ".role"
},
{
"identity" : "fhirauditevent",
"map" : "AuditEvent.agent.type"
},
{
"identity" : "w3c.prov",
"map" : "Agent.Attribution"
}]
},
{
"id" : "Provenance.agent.role",
"path" : "Provenance.agent.role",
"short" : "What the agents role was",
"definition" : "The function of the agent with respect to the activity. The security role enabling the agent with respect to the activity.",
"comment" : "For example: doctor, nurse, clerk, etc.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ProvenanceAgentRole"
}],
"strength" : "example",
"description" : "The role that a provenance agent played with respect to the activity.",
"valueSet" : "http://hl7.org/fhir/ValueSet/security-role-type"
},
"mapping" : [{
"identity" : "rim",
"map" : ".typecode"
},
{
"identity" : "fhirauditevent",
"map" : "AuditEvent.agent.role"
}]
},
{
"id" : "Provenance.agent.who",
"path" : "Provenance.agent.who",
"short" : "Who participated",
"definition" : "The individual, device or organization that participated in the event.",
"comment" : "whoIdentity should be used when the agent is not a Resource type.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson",
"http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Device",
"http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.performer.actor"
},
{
"identity" : "w5",
"map" : "FiveWs.actor"
},
{
"identity" : "rim",
"map" : ".id"
}]
},
{
"id" : "Provenance.agent.onBehalfOf",
"path" : "Provenance.agent.onBehalfOf",
"short" : "Who the agent is representing",
"definition" : "The individual, device, or organization for whom the change was made.",
"comment" : "onBehalfOfIdentity should be used when the agent is not a Resource type.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson",
"http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Device",
"http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"mapping" : [{
"identity" : "rim",
"map" : "Person, Practitioner, Organization, Device :* .role [classCode = RoleClassMutualRelationship; role.code and * .scopes[Role](classCode=IDENT) and *.plays [Role.Code]"
}]
},
{
"id" : "Provenance.entity",
"path" : "Provenance.entity",
"short" : "An entity used in this activity",
"definition" : "An entity used in this activity.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"mapping" : [{
"identity" : "rim",
"map" : "./subjectOf"
},
{
"identity" : "fhirauditevent",
"map" : "AuditEvent.entity"
},
{
"identity" : "w3c.prov",
"map" : "Entity"
}]
},
{
"id" : "Provenance.entity.role",
"path" : "Provenance.entity.role",
"short" : "derivation | revision | quotation | source | removal",
"definition" : "How the entity was used during the activity.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ProvenanceEntityRole"
}],
"strength" : "required",
"description" : "How an entity was used in an activity.",
"valueSet" : "http://hl7.org/fhir/ValueSet/provenance-entity-role|4.0.1"
},
"mapping" : [{
"identity" : "rim",
"map" : "./typeCode"
},
{
"identity" : "fhirauditevent",
"map" : "AuditEvent.entity.lifecycle"
},
{
"identity" : "w3c.prov",
"map" : "Entity.role"
}]
},
{
"id" : "Provenance.entity.what",
"path" : "Provenance.entity.what",
"short" : "Identity of entity",
"definition" : "Identity of the Entity used. May be a logical or physical uri and maybe absolute or relative.",
"comment" : "whatIdentity should be used for entities that are not a Resource type.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "./text/reference"
},
{
"identity" : "fhirauditevent",
"map" : "AuditEvent.entity.reference"
},
{
"identity" : "w3c.prov",
"map" : "Entity.Identity"
}]
},
{
"id" : "Provenance.entity.agent",
"path" : "Provenance.entity.agent",
"short" : "Entity is attributed to this agent",
"definition" : "The entity is attributed to an agent to express the agent's responsibility for that entity, possibly along with other agents. This description can be understood as shorthand for saying that the agent was responsible for the activity which generated the entity.",
"comment" : "A usecase where one Provenance.entity.agent is used where the Entity that was used in the creation/updating of the Target, is not in the context of the same custodianship as the Target, and thus the meaning of Provenance.entity.agent is to say that the entity referenced is managed elsewhere and that this Agent provided access to it. This would be similar to where the Entity being referenced is managed outside FHIR, such as through HL7 v2, v3, or XDS. This might be where the Entity being referenced is managed in another FHIR resource server. Thus it explains the Provenance of that Entity's use in the context of this Provenance activity.",
"min" : 0,
"max" : "*",
"contentReference" : "#Provenance.agent",
"mapping" : [{
"identity" : "rim",
"map" : "./author/role"
}]
},
{
"id" : "Provenance.signature",
"path" : "Provenance.signature",
"short" : "Signature on target",
"definition" : "A digital signature on the target Reference(s). The signer should match a Provenance.agent. The purpose of the signature is indicated.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Signature"
}],
"mapping" : [{
"identity" : "rim",
"map" : "./signatureText"
}]
}]
}
}
},
{
"fullUrl" : "http://hl7.org/fhir/StructureDefinition/Questionnaire",
"resource" : {
"resourceType" : "StructureDefinition",
"id" : "Questionnaire",
"meta" : {
"lastUpdated" : "2019-11-01T09:29:23.356+11:00"
},
"text" : {
"status" : "generated",
"div" : "Name Flags Card. Type Description & Constraints Questionnaire ITU 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 url Σ 0..1 uri Canonical identifier for this questionnaire, represented as a URI (globally unique) identifier Σ 0..* Identifier Additional identifier for the questionnaire
version Σ 0..1 string Business version of the questionnaire name ΣI 0..1 string Name for this questionnaire (computer friendly) title Σ 0..1 string Name for this questionnaire (human friendly) derivedFrom 0..* canonical(Questionnaire) Instantiates protocol or definition
status ?!Σ 1..1 code draft | active | retired | unknown
PublicationStatus (Required) experimental Σ 0..1 boolean For testing purposes, not real usage subjectType Σ 0..* code Resource that can be subject of QuestionnaireResponse
ResourceType (Required)
date Σ 0..1 dateTime Date last changed publisher Σ 0..1 string Name of the publisher (organization or individual) contact Σ 0..* ContactDetail Contact details for the publisher
description 0..1 markdown Natural language description of the questionnaire useContext Σ 0..* UsageContext The context that the content is intended to support
jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for questionnaire (if applicable)
Jurisdiction (Extensible)
purpose 0..1 markdown Why this questionnaire is defined copyright 0..1 markdown Use and/or publishing restrictions approvalDate 0..1 date When the questionnaire was approved by publisher lastReviewDate 0..1 date When the questionnaire was last reviewed effectivePeriod Σ 0..1 Period When the questionnaire is expected to be used code Σ 0..* Coding Concept that represents the overall questionnaire
Questionnaire Question Codes (Example)
item I 0..* BackboneElement Questions and sections within the Questionnaire
+ Rule: Group items must have nested items, display items cannot have nested items
+ Rule: Display items cannot have a "code" asserted
+ Rule: A question cannot have both answerOption and answerValueSet
+ Rule: Only 'choice' and 'open-choice' items can have 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[x] must be missing
+ Rule: If there are more than one enableWhen, enableBehavior must be specified
+ Rule: Can only have multiple initial values for repeating items
linkId 1..1 string Unique id for item in questionnaire definition 0..1 uri ElementDefinition - details for the item code I 0..* Coding Corresponding concept for this item in a terminology
Questionnaire Question Codes (Example)
prefix 0..1 string E.g. "1(a)", "2.5.3" text 0..1 string Primary text for the item type 1..1 code group | display | boolean | decimal | integer | date | dateTime +
QuestionnaireItemType (Required) enableWhen ?!I 0..* BackboneElement Only allow data when
+ Rule: If the operator is 'exists', the value must be a boolean
question 1..1 string Question that determines whether item is enabled operator 1..1 code exists | = | != | > | < | >= | <=
QuestionnaireItemOperator (Required) answer[x] I 1..1 Value for question comparison based on operator
Questionnaire Answer Codes (Example) answerBoolean boolean answerDecimal decimal answerInteger integer answerDate date answerDateTime dateTime answerTime time answerString string answerCoding Coding answerQuantity Quantity answerReference Reference(Any) enableBehavior I 0..1 code all | any
EnableWhenBehavior (Required) required I 0..1 boolean Whether the item must be included in data results repeats I 0..1 boolean Whether the item may repeat readOnly I 0..1 boolean Don't allow human editing maxLength I 0..1 integer No more than this many characters answerValueSet I 0..1 canonical(ValueSet) Valueset containing permitted answers answerOption I 0..* BackboneElement Permitted answer
value[x] 1..1 Answer value
Questionnaire Answer Codes (Example) valueInteger integer valueDate date valueTime time valueString string valueCoding Coding valueReference Reference(Any) initialSelected 0..1 boolean Whether option is selected by default initial I 0..* BackboneElement Initial value(s) when item is first rendered
value[x] 1..1 Actual value for initializing the question
Questionnaire Answer Codes (Example) valueBoolean boolean valueDecimal decimal valueInteger integer valueDate date valueDateTime dateTime valueTime time valueString string valueUri uri valueAttachment Attachment valueCoding Coding valueQuantity Quantity valueReference Reference(Any) item I 0..* see item Nested questionnaire items
Documentation for this format
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Specialized.Definitional Artifacts"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 3
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "business"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "fhir"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/Questionnaire",
"version" : "4.0.1",
"name" : "Questionnaire",
"status" : "draft",
"date" : "2019-11-01T09:29:23+11:00",
"publisher" : "Health Level Seven International (FHIR Infrastructure)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/fiwg/index.cfm"
}]
}],
"description" : "A structured set of questions intended to guide the collection of answers from end-users. Questionnaires provide detailed control over order, presentation, phraseology and grouping to allow coherent, consistent data collection.",
"purpose" : "To support structured, hierarchical registration of data gathered using digital forms and other questionnaires. Questionnaires provide greater control over presentation and allow capture of data in a domain-independent way (i.e. capturing information that would otherwise require multiple distinct types of resources).",
"fhirVersion" : "4.0.1",
"mapping" : [{
"identity" : "workflow",
"uri" : "http://hl7.org/fhir/workflow",
"name" : "Workflow Pattern"
},
{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/fivews",
"name" : "FiveWs Pattern Mapping"
},
{
"identity" : "objimpl",
"uri" : "http://hl7.org/fhir/object-implementation",
"name" : "Object Implementation Information"
},
{
"identity" : "v2",
"uri" : "http://hl7.org/v2",
"name" : "HL7 v2 Mapping"
}],
"kind" : "resource",
"abstract" : false,
"type" : "Questionnaire",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"_baseDefinition" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-codegen-super",
"valueString" : "MetadataResource"
}]
},
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "Questionnaire",
"path" : "Questionnaire",
"short" : "A structured set of questions",
"definition" : "A structured set of questions intended to guide the collection of answers from end-users. Questionnaires provide detailed control over order, presentation, phraseology and grouping to allow coherent, consistent data collection.",
"alias" : ["Form",
"CRF",
"Survey"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Questionnaire",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "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",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.`div`.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "que-0",
"severity" : "warning",
"human" : "Name should be usable as an identifier for the module by machine processing applications such as code generation",
"expression" : "name.matches('[A-Z]([A-Za-z0-9_]){0,254}')",
"xpath" : "not(exists(f:name/@value)) or matches(f:name/@value, '[A-Z]([A-Za-z0-9_]){0,254}')"
},
{
"key" : "que-2",
"severity" : "error",
"human" : "The link ids for groups and questions must be unique within the questionnaire",
"expression" : "descendants().linkId.isDistinct()",
"xpath" : "count(descendant::f:linkId/@value)=count(distinct-values(descendant::f:linkId/@value))"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "workflow",
"map" : "Definition"
},
{
"identity" : "rim",
"map" : "Observation[moodCode=DEF]"
}]
},
{
"id" : "Questionnaire.id",
"path" : "Questionnaire.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Questionnaire.meta",
"path" : "Questionnaire.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Questionnaire.implicitRules",
"path" : "Questionnaire.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "Questionnaire.language",
"path" : "Questionnaire.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "Questionnaire.text",
"path" : "Questionnaire.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "Questionnaire.contained",
"path" : "Questionnaire.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Questionnaire.extension",
"path" : "Questionnaire.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Questionnaire.modifierExtension",
"path" : "Questionnaire.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Questionnaire.url",
"path" : "Questionnaire.url",
"short" : "Canonical identifier for this questionnaire, represented as a URI (globally unique)",
"definition" : "An absolute URI that is used to identify this questionnaire when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this questionnaire is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the questionnaire is stored on different servers.",
"comment" : "The name of the referenced questionnaire can be conveyed using the http://hl7.org/fhir/StructureDefinition/display extension.",
"requirements" : "… This is the id that will be used to link a QuestionnaireResponse to the Questionnaire the response is for.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Questionnaire.url",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.url"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "rim",
"map" : ".identifier[scope=BUSN;reliability=ISS]"
}]
},
{
"id" : "Questionnaire.identifier",
"path" : "Questionnaire.identifier",
"short" : "Additional identifier for the questionnaire",
"definition" : "A formal identifier that is used to identify this questionnaire when it is represented in other formats, or referenced in a specification, model, design or an instance.",
"comment" : "Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this questionnaire outside of FHIR, where it is not possible to use the logical URI.",
"requirements" : "Allows externally provided and/or usable business identifiers to be easily associated with the module.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Questionnaire.identifier",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Identifier"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.identifier"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "rim",
"map" : ".identifier"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "Questionnaire.version",
"path" : "Questionnaire.version",
"short" : "Business version of the questionnaire",
"definition" : "The identifier that is used to identify this version of the questionnaire when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the questionnaire author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.",
"comment" : "There may be different questionnaire instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the questionnaire with the format [url]|[version].",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Questionnaire.version",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.version"
},
{
"identity" : "w5",
"map" : "FiveWs.version"
},
{
"identity" : "rim",
"map" : "N/A (to add?)"
}]
},
{
"id" : "Questionnaire.name",
"path" : "Questionnaire.name",
"short" : "Name for this questionnaire (computer friendly)",
"definition" : "A natural language name identifying the questionnaire. This name should be usable as an identifier for the module by machine processing applications such as code generation.",
"comment" : "The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.",
"requirements" : "Support human navigation and code generation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Questionnaire.name",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"condition" : ["inv-0"],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Questionnaire.title",
"path" : "Questionnaire.title",
"short" : "Name for this questionnaire (human friendly)",
"definition" : "A short, descriptive, user-friendly title for the questionnaire.",
"comment" : "This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Questionnaire.title",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.title"
},
{
"identity" : "rim",
"map" : ".title"
}]
},
{
"id" : "Questionnaire.derivedFrom",
"path" : "Questionnaire.derivedFrom",
"short" : "Instantiates protocol or definition",
"definition" : "The URL of a Questionnaire that this Questionnaire is based on.",
"requirements" : "Allows a Questionnaire to be created based on another Questionnaire.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Questionnaire.derivedFrom",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Questionnaire"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.derivedFrom"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=DRIV].target[classCode=OBS, moodCode=DEFN]"
}]
},
{
"id" : "Questionnaire.status",
"path" : "Questionnaire.status",
"short" : "draft | active | retired | unknown",
"definition" : "The status of this questionnaire. Enables tracking the life-cycle of the content.",
"comment" : "Allows filtering of questionnaires that are appropriate for use versus not.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Questionnaire.status",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This is labeled as \"Is Modifier\" because applications should not use a retired {{title}} without due consideration",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "PublicationStatus"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "The lifecycle status of an artifact.",
"valueSet" : "http://hl7.org/fhir/ValueSet/publication-status|4.0.1"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.status"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
},
{
"identity" : "rim",
"map" : ".status"
}]
},
{
"id" : "Questionnaire.experimental",
"path" : "Questionnaire.experimental",
"short" : "For testing purposes, not real usage",
"definition" : "A Boolean value to indicate that this questionnaire is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.",
"comment" : "Allows filtering of questionnaires that are appropriate for use versus not.",
"requirements" : "Enables experimental content to be developed following the same lifecycle that would be used for a production-level questionnaire.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Questionnaire.experimental",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.experimental"
},
{
"identity" : "w5",
"map" : "FiveWs.class"
},
{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Questionnaire.subjectType",
"path" : "Questionnaire.subjectType",
"short" : "Resource that can be subject of QuestionnaireResponse",
"definition" : "The types of subjects that can be the subject of responses created for the questionnaire.",
"comment" : "If none are specified, then the subject is unlimited.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Questionnaire.subjectType",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ResourceType"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "One of the resource types defined as part of this version of FHIR.",
"valueSet" : "http://hl7.org/fhir/ValueSet/resource-types|4.0.1"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.subject[x]"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=META].target[classCode=OBS, moodCode=DEFN, isCriterion=true].participation.role.classCode"
}]
},
{
"id" : "Questionnaire.date",
"path" : "Questionnaire.date",
"short" : "Date last changed",
"definition" : "The date (and optionally time) when the questionnaire was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the questionnaire changes.",
"comment" : "Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the questionnaire. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.",
"alias" : ["Revision Date"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Questionnaire.date",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.date"
},
{
"identity" : "w5",
"map" : "FiveWs.recorded"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=AUT].time"
}]
},
{
"id" : "Questionnaire.publisher",
"path" : "Questionnaire.publisher",
"short" : "Name of the publisher (organization or individual)",
"definition" : "The name of the organization or individual that published the questionnaire.",
"comment" : "Usually an organization but may be an individual. The publisher (or steward) of the questionnaire is the organization or individual primarily responsible for the maintenance and upkeep of the questionnaire. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the questionnaire. This item SHOULD be populated unless the information is available from context.",
"requirements" : "Helps establish the \"authority/credibility\" of the questionnaire. May also allow for contact.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Questionnaire.publisher",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.publisher"
},
{
"identity" : "w5",
"map" : "FiveWs.witness"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=AUT].role"
}]
},
{
"id" : "Questionnaire.contact",
"path" : "Questionnaire.contact",
"short" : "Contact details for the publisher",
"definition" : "Contact details to assist a user in finding and communicating with the publisher.",
"comment" : "May be a web site, an email address, a telephone number, etc.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Questionnaire.contact",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "ContactDetail"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.contact"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=CALLBCK].role"
}]
},
{
"id" : "Questionnaire.description",
"path" : "Questionnaire.description",
"short" : "Natural language description of the questionnaire",
"definition" : "A free text natural language description of the questionnaire from a consumer's perspective.",
"comment" : "This description can be used to capture details such as why the questionnaire was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the questionnaire as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the questionnaire is presumed to be the predominant language in the place the questionnaire was created).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Questionnaire.description",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "markdown"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.description"
},
{
"identity" : "rim",
"map" : ".text"
}]
},
{
"id" : "Questionnaire.useContext",
"path" : "Questionnaire.useContext",
"short" : "The context that the content is intended to support",
"definition" : "The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate questionnaire instances.",
"comment" : "When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.",
"requirements" : "Assist in searching for appropriate content.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Questionnaire.useContext",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "UsageContext"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.useContext"
},
{
"identity" : "rim",
"map" : "N/A (to add?)"
}]
},
{
"id" : "Questionnaire.jurisdiction",
"path" : "Questionnaire.jurisdiction",
"short" : "Intended jurisdiction for questionnaire (if applicable)",
"definition" : "A legal or geographic region in which the questionnaire is intended to be used.",
"comment" : "It may be possible for the questionnaire to be used in jurisdictions other than those for which it was originally designed or intended.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Questionnaire.jurisdiction",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Jurisdiction"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "extensible",
"description" : "Countries and regions within which this artifact is targeted for use.",
"valueSet" : "http://hl7.org/fhir/ValueSet/jurisdiction"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.jurisdiction"
},
{
"identity" : "rim",
"map" : "N/A (to add?)"
}]
},
{
"id" : "Questionnaire.purpose",
"path" : "Questionnaire.purpose",
"short" : "Why this questionnaire is defined",
"definition" : "Explanation of why this questionnaire is needed and why it has been designed as it has.",
"comment" : "This element does not describe the usage of the questionnaire. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this questionnaire.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Questionnaire.purpose",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "markdown"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.purpose"
},
{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "rim",
"map" : ".reasonCode.text"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "Questionnaire.copyright",
"path" : "Questionnaire.copyright",
"short" : "Use and/or publishing restrictions",
"definition" : "A copyright statement relating to the questionnaire and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the questionnaire.",
"requirements" : "Consumers must be able to determine any legal restrictions on the use of the questionnaire and/or its content.",
"alias" : ["License",
"Restrictions"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Questionnaire.copyright",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "markdown"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.copyright"
},
{
"identity" : "rim",
"map" : "N/A (to add?)"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "Questionnaire.approvalDate",
"path" : "Questionnaire.approvalDate",
"short" : "When the questionnaire was approved by publisher",
"definition" : "The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.",
"comment" : "The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Questionnaire.approvalDate",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "date"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.approvalDate"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=\"SUBJ\"].act[classCode=CACT;moodCode=EVN;code=\"approval\"].effectiveTime"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "Questionnaire.lastReviewDate",
"path" : "Questionnaire.lastReviewDate",
"short" : "When the questionnaire was last reviewed",
"definition" : "The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.",
"comment" : "If specified, this date follows the original approval date.",
"requirements" : "Gives a sense of how \"current\" the content is. Resources that have not been reviewed in a long time may have a risk of being less appropriate/relevant.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Questionnaire.lastReviewDate",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "date"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.lastReviewDate"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=\"SUBJ\"; subsetCode=\"RECENT\"].act[classCode=CACT;moodCode=EVN;code=\"review\"].effectiveTime"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "Questionnaire.effectivePeriod",
"path" : "Questionnaire.effectivePeriod",
"short" : "When the questionnaire is expected to be used",
"definition" : "The period during which the questionnaire content was or is planned to be in active use.",
"comment" : "The effective period for a questionnaire determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 might be published in 2015.",
"requirements" : "Allows establishing a transition before a resource comes into effect and also allows for a sunsetting process when new versions of the questionnaire are or are expected to be used instead.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Questionnaire.effectivePeriod",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Period"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.effectivePeriod"
},
{
"identity" : "rim",
"map" : "N/A (to add?)"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "Questionnaire.code",
"path" : "Questionnaire.code",
"short" : "Concept that represents the overall questionnaire",
"definition" : "An identifier for this question or group of questions in a particular terminology such as LOINC.",
"requirements" : "Allows linking of the complete Questionnaire resources to formal terminologies. It's common for \"panels\" of questions to be identified by a code.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Questionnaire.code",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Coding"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "QuestionnaireConcept"
}],
"strength" : "example",
"description" : "Codes for questionnaires, groups and individual questions.",
"valueSet" : "http://hl7.org/fhir/ValueSet/questionnaire-questions"
},
"mapping" : [{
"identity" : "rim",
"map" : ".code"
}]
},
{
"id" : "Questionnaire.item",
"path" : "Questionnaire.item",
"short" : "Questions and sections within the Questionnaire",
"definition" : "A particular question, question grouping or display text that is part of the questionnaire.",
"comment" : "The content of the questionnaire is constructed from an ordered, hierarchical collection of items.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Questionnaire.item",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"condition" : ["que-3"],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "que-1",
"severity" : "error",
"human" : "Group items must have nested items, display items cannot have nested items",
"expression" : "(type='group' implies item.empty().not()) and (type.trace('type')='display' implies item.trace('item').empty())",
"xpath" : "not((f:type/@value='group' and not(f:item)) or (f:type/@value='display' and f:item))"
},
{
"key" : "que-3",
"severity" : "error",
"human" : "Display items cannot have a \"code\" asserted",
"expression" : "type!='display' or code.empty()",
"xpath" : "not(f:type/@value='display' and f:code)"
},
{
"key" : "que-4",
"severity" : "error",
"human" : "A question cannot have both answerOption and answerValueSet",
"expression" : "answerOption.empty() or answerValueSet.empty()",
"xpath" : "not(f:answerValueSet and f:answerOption)"
},
{
"key" : "que-5",
"severity" : "error",
"human" : "Only 'choice' and 'open-choice' items can have answerValueSet",
"expression" : "(type ='choice' or type = 'open-choice' or type = 'decimal' or type = 'integer' or type = 'date' or type = 'dateTime' or type = 'time' or type = 'string' or type = 'quantity') or (answerValueSet.empty() and answerOption.empty())",
"xpath" : "f:type/@value=('choice','open-choice','decimal','integer','date','dateTime','time','string','quantity',') or not(f:answerOption or f:answerValueSet)"
},
{
"key" : "que-6",
"severity" : "error",
"human" : "Required and repeat aren't permitted for display items",
"expression" : "type!='display' or (required.empty() and repeats.empty())",
"xpath" : "not(f:type/@value='display' and (f:required or f:repeats))"
},
{
"key" : "que-8",
"severity" : "error",
"human" : "Initial values can't be specified for groups or display items",
"expression" : "(type!='group' and type!='display') or initial.empty()",
"xpath" : "not(f:type/@value=('group', 'display') and f:*[starts-with(local-name(.), 'initial')])"
},
{
"key" : "que-9",
"severity" : "error",
"human" : "Read-only can't be specified for \"display\" items",
"expression" : "type!='display' or readOnly.empty()",
"xpath" : "not(f:type/@value=('group', 'display') and f:*[starts-with(local-name(.), 'initial')])"
},
{
"key" : "que-10",
"severity" : "error",
"human" : "Maximum length can only be declared for simple question types",
"expression" : "(type in ('boolean' | 'decimal' | 'integer' | 'string' | 'text' | 'url' | 'open-choice')) or maxLength.empty()",
"xpath" : "f:type/@value=('boolean', 'decimal', 'integer', 'open-choice', 'string', 'text', 'url') or not(f:maxLength)"
},
{
"key" : "que-11",
"severity" : "error",
"human" : "If one or more answerOption is present, initial[x] must be missing",
"expression" : "answerOption.empty() or initial.empty()",
"xpath" : "not(f:answerOption) or not(count(f:*[starts-with(local-name(.), 'initial')]))"
},
{
"key" : "que-12",
"severity" : "error",
"human" : "If there are more than one enableWhen, enableBehavior must be specified",
"expression" : "enableWhen.count() > 2 implies enableBehavior.exists()",
"xpath" : "not(f:answerOption) or not(count(f:*[starts-with(local-name(.), 'initial')]))"
},
{
"key" : "que-13",
"severity" : "error",
"human" : "Can only have multiple initial values for repeating items",
"expression" : "repeats=true or initial.count() <= 1",
"xpath" : "f:repeats/@value='true' or count(f:initial)<=1"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=COMP].target[classCode=OBS, moodCode=DEF]"
}]
},
{
"id" : "Questionnaire.item.id",
"path" : "Questionnaire.item.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Questionnaire.item.extension",
"path" : "Questionnaire.item.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Questionnaire.item.modifierExtension",
"path" : "Questionnaire.item.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Questionnaire.item.linkId",
"path" : "Questionnaire.item.linkId",
"short" : "Unique id for item in questionnaire",
"definition" : "An identifier that is unique within the Questionnaire allowing linkage to the equivalent item in a QuestionnaireResponse resource.",
"comment" : "This ''can'' be a meaningful identifier (e.g. a LOINC code) but is not intended to have any meaning. GUIDs or sequential numbers are appropriate here.",
"requirements" : "[QuestionnaireResponse](questionnaireresponse.html#) does not require omitted items to be included and may have some items that repeat, so linkage based on position alone is not sufficient.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Questionnaire.item.linkId",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".id"
}]
},
{
"id" : "Questionnaire.item.definition",
"path" : "Questionnaire.item.definition",
"short" : "ElementDefinition - details for the item",
"definition" : "This element is a URI that refers to an [ElementDefinition](elementdefinition.html) that provides information about this item, including information that might otherwise be included in the instance of the Questionnaire resource. A detailed description of the construction of the URI is shown in Comments, below. If this element is present then the following element values MAY be derived from the Element Definition if the corresponding elements of this Questionnaire resource instance have no value:\n\n* code (ElementDefinition.code) \n* type (ElementDefinition.type) \n* required (ElementDefinition.min) \n* repeats (ElementDefinition.max) \n* maxLength (ElementDefinition.maxLength) \n* answerValueSet (ElementDefinition.binding)\n* options (ElementDefinition.binding).",
"comment" : "The uri refers to an ElementDefinition in a [StructureDefinition](structuredefinition.html#) and always starts with the [canonical URL](references.html#canonical) for the target resource. When referring to a StructureDefinition, a fragment identifier is used to specify the element definition by its id [Element.id](element-definitions.html#Element.id). E.g. http://hl7.org/fhir/StructureDefinition/Observation#Observation.value[x]. In the absence of a fragment identifier, the first/root element definition in the target is the matching element definition.",
"requirements" : "A common pattern is to define a set of data elements and then build multiple questionnaires for different circumstances to gather the data. This element provides traceability to the common definition and allows the content for the question to come from the underlying definition.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Questionnaire.item.definition",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=INST].target[classCode=OBS, moodCode=DEF]"
}]
},
{
"id" : "Questionnaire.item.code",
"path" : "Questionnaire.item.code",
"short" : "Corresponding concept for this item in a terminology",
"definition" : "A terminology code that corresponds to this group or question (e.g. a code from LOINC, which defines many questions and answers).",
"comment" : "The value may come from the ElementDefinition referred to by .definition.",
"requirements" : "Allows linking of groups of questions to formal terminologies.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Questionnaire.item.code",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Coding"
}],
"condition" : ["que-3"],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "QuestionnaireConcept"
}],
"strength" : "example",
"description" : "Codes for questionnaires, groups and individual questions.",
"valueSet" : "http://hl7.org/fhir/ValueSet/questionnaire-questions"
},
"mapping" : [{
"identity" : "rim",
"map" : ".code"
}]
},
{
"id" : "Questionnaire.item.prefix",
"path" : "Questionnaire.item.prefix",
"short" : "E.g. \"1(a)\", \"2.5.3\"",
"definition" : "A short label for a particular group, question or set of display text within the questionnaire used for reference by the individual completing the questionnaire.",
"comment" : "These are generally unique within a questionnaire, though this is not guaranteed. Some questionnaires may have multiple questions with the same label with logic to control which gets exposed. Typically, these won't be used for \"display\" items, though such use is not prohibited. Systems SHOULD NOT generate their own prefixes if prefixes are defined for any items within a Questionnaire.",
"requirements" : "Separating the label from the question text allows improved rendering. Also, instructions will often refer to specific prefixes, so there's a need for the questionnaire design to have control over what labels are used.",
"alias" : ["label"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Questionnaire.item.prefix",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Not supported"
}]
},
{
"id" : "Questionnaire.item.text",
"path" : "Questionnaire.item.text",
"short" : "Primary text for the item",
"definition" : "The name of a section, the text of a question or text content for a display item.",
"comment" : "When using this element to represent the name of a section, use group type item and also make sure to limit the text element to a short string suitable for display as a section heading. Group item instructions should be included as a display type item within the group.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Questionnaire.item.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".text"
}]
},
{
"id" : "Questionnaire.item.type",
"path" : "Questionnaire.item.type",
"short" : "group | display | boolean | decimal | integer | date | dateTime +",
"definition" : "The type of questionnaire item this is - whether text for display, a grouping of other items or a particular type of data to be captured (string, integer, coded choice, etc.).",
"comment" : "Additional constraints on the type of answer can be conveyed by extensions. The value may come from the ElementDefinition referred to by .definition.",
"requirements" : "Defines the format in which the user is to be prompted for the answer.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Questionnaire.item.type",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "QuestionnaireItemType"
}],
"strength" : "required",
"description" : "Distinguishes groups from questions and display text and indicates data type for questions.",
"valueSet" : "http://hl7.org/fhir/ValueSet/item-type|4.0.1"
},
"mapping" : [{
"identity" : "rim",
"map" : "N/A - MIF rather than RIM level"
}]
},
{
"id" : "Questionnaire.item.enableWhen",
"path" : "Questionnaire.item.enableWhen",
"short" : "Only allow data when",
"definition" : "A constraint indicating that this item should only be enabled (displayed/allow answers to be captured) when the specified condition is true.",
"comment" : "If multiple repetitions of this extension are present, the item should be enabled when the condition for *any* of the repetitions is true. I.e. treat \"enableWhen\"s as being joined by an \"or\" clause. This element is a modifier because if enableWhen is present for an item, \"required\" is ignored unless one of the enableWhen conditions is met. When an item is disabled, all of its descendants are disabled, regardless of what their own enableWhen logic might evaluate to.",
"requirements" : "Allows questionnaires to adapt based on answers to other questions. E.g. If physical gender is specified as a male, no need to capture pregnancy history. Also allows conditional display of instructions or groups of questions.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Questionnaire.item.enableWhen",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "que-7",
"severity" : "error",
"human" : "If the operator is 'exists', the value must be a boolean",
"expression" : "operator = 'exists' implies (answer is Boolean)",
"xpath" : "f:operator/@value != 'exists' or exists(f:answerBoolean)"
}],
"isModifier" : true,
"isModifierReason" : "If enableWhen is present and the condition evaluates to false, then the Questionnaire behaves as though the elements weren't actually present",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A - MIF rather than RIM level"
}]
},
{
"id" : "Questionnaire.item.enableWhen.id",
"path" : "Questionnaire.item.enableWhen.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Questionnaire.item.enableWhen.extension",
"path" : "Questionnaire.item.enableWhen.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Questionnaire.item.enableWhen.modifierExtension",
"path" : "Questionnaire.item.enableWhen.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Questionnaire.item.enableWhen.question",
"path" : "Questionnaire.item.enableWhen.question",
"short" : "Question that determines whether item is enabled",
"definition" : "The linkId for the question whose answer (or lack of answer) governs whether this item is enabled.",
"comment" : "If multiple question occurrences are present for the same question (same linkId), then this refers to the nearest question occurrence reachable by tracing first the \"ancestor\" axis and then the \"preceding\" axis and then the \"following\" axis.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Questionnaire.item.enableWhen.question",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A - MIF rather than RIM level"
}]
},
{
"id" : "Questionnaire.item.enableWhen.operator",
"path" : "Questionnaire.item.enableWhen.operator",
"short" : "exists | = | != | > | < | >= | <=",
"definition" : "Specifies the criteria by which the question is enabled.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Questionnaire.item.enableWhen.operator",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "QuestionnaireItemOperator"
}],
"strength" : "required",
"description" : "The criteria by which a question is enabled.",
"valueSet" : "http://hl7.org/fhir/ValueSet/questionnaire-enable-operator|4.0.1"
},
"mapping" : [{
"identity" : "rim",
"map" : "N/A - MIF rather than RIM level"
}]
},
{
"id" : "Questionnaire.item.enableWhen.answer[x]",
"path" : "Questionnaire.item.enableWhen.answer[x]",
"short" : "Value for question comparison based on operator",
"definition" : "A value that the referenced question is tested using the specified operator in order for the item to be enabled.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Questionnaire.item.enableWhen.answer[x]",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "boolean"
},
{
"code" : "decimal"
},
{
"code" : "integer"
},
{
"code" : "date"
},
{
"code" : "dateTime"
},
{
"code" : "time"
},
{
"code" : "string"
},
{
"code" : "Coding"
},
{
"code" : "Quantity"
},
{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"condition" : ["que-7"],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "QuestionnaireQuestionOption3"
}],
"strength" : "example",
"description" : "Allowed values to answer questions.",
"valueSet" : "http://hl7.org/fhir/ValueSet/questionnaire-answers"
},
"mapping" : [{
"identity" : "rim",
"map" : "N/A - MIF rather than RIM level"
}]
},
{
"id" : "Questionnaire.item.enableBehavior",
"path" : "Questionnaire.item.enableBehavior",
"short" : "all | any",
"definition" : "Controls how multiple enableWhen values are interpreted - whether all or any must be true.",
"comment" : "This element must be specified if more than one enableWhen value is provided.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Questionnaire.item.enableBehavior",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"condition" : ["que-12"],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "EnableWhenBehavior"
}],
"strength" : "required",
"description" : "Controls how multiple enableWhen values are interpreted - whether all or any must be true.",
"valueSet" : "http://hl7.org/fhir/ValueSet/questionnaire-enable-behavior|4.0.1"
},
"mapping" : [{
"identity" : "rim",
"map" : "N/A - MIF rather than RIM level"
}]
},
{
"id" : "Questionnaire.item.required",
"path" : "Questionnaire.item.required",
"short" : "Whether the item must be included in data results",
"definition" : "An indication, if true, that the item must be present in a \"completed\" QuestionnaireResponse. If false, the item may be skipped when answering the questionnaire.",
"comment" : "Questionnaire.item.required only has meaning for elements that are conditionally enabled with enableWhen if the condition evaluates to true. If an item that contains other items is marked as required, that does not automatically make the contained elements required (though required groups must contain at least one child element). The value may come from the ElementDefinition referred to by .definition.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Questionnaire.item.required",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"meaningWhenMissing" : "Items are generally assumed not to be required unless explicitly specified. Systems SHOULD always populate this value",
"condition" : ["que-6"],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A - MIF rather than RIM level"
}]
},
{
"id" : "Questionnaire.item.repeats",
"path" : "Questionnaire.item.repeats",
"short" : "Whether the item may repeat",
"definition" : "An indication, if true, that the item may occur multiple times in the response, collecting multiple answers for questions or multiple sets of answers for groups.",
"comment" : "If a question is marked as repeats=true, then multiple answers can be provided for the question in the corresponding QuestionnaireResponse. When rendering the questionnaire, it is up to the rendering software whether to render the question text for each answer repetition (i.e. \"repeat the question\") or to simply allow entry/selection of multiple answers for the question (repeat the answers). Which is most appropriate visually may depend on the type of answer as well as whether there are nested items.\n\nThe resulting QuestionnaireResponse will be populated the same way regardless of rendering - one 'question' item with multiple answer values.\n\n The value may come from the ElementDefinition referred to by .definition.",
"requirements" : "Items may be used to create set of (related) questions that can be repeated to give multiple answers to such a set.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Questionnaire.item.repeats",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"meaningWhenMissing" : "Items are generally assumed not to repeat unless explicitly specified. Systems SHOULD always populate this value",
"condition" : ["que-6"],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A - MIF rather than RIM level"
}]
},
{
"id" : "Questionnaire.item.readOnly",
"path" : "Questionnaire.item.readOnly",
"short" : "Don't allow human editing",
"definition" : "An indication, when true, that the value cannot be changed by a human respondent to the Questionnaire.",
"comment" : "The value of readOnly elements can be established by asserting extensions for defaultValues, linkages that support pre-population and/or extensions that support calculation based on other answers.",
"requirements" : "Allows certain information to be phrased (and rendered) as a question and an answer, while keeping users from changing it. May also be useful for preventing changes to pre-populated portions of a questionnaire, for calculated values, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Questionnaire.item.readOnly",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"condition" : ["que-9"],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A - MIF rather than RIM level"
}]
},
{
"id" : "Questionnaire.item.maxLength",
"path" : "Questionnaire.item.maxLength",
"short" : "No more than this many characters",
"definition" : "The maximum number of characters that are permitted in the answer to be considered a \"valid\" QuestionnaireResponse.",
"comment" : "For base64binary, reflects the number of characters representing the encoded data, not the number of bytes of the binary data. The value may come from the ElementDefinition referred to by .definition.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Questionnaire.item.maxLength",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "integer"
}],
"condition" : ["que-10"],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "N/A"
},
{
"identity" : "rim",
"map" : "N/A - MIF rather than RIM level"
}]
},
{
"id" : "Questionnaire.item.answerValueSet",
"path" : "Questionnaire.item.answerValueSet",
"short" : "Valueset containing permitted answers",
"definition" : "A reference to a value set containing a list of codes representing permitted answers for a \"choice\" or \"open-choice\" question.",
"comment" : "LOINC defines many useful value sets for questionnaire responses. See [LOINC Answer Lists](loinc.html#alist). The value may come from the ElementDefinition referred to by .definition.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Questionnaire.item.answerValueSet",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ValueSet"]
}],
"condition" : ["que-4",
"que-5"],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A - MIF rather than RIM level"
}]
},
{
"id" : "Questionnaire.item.answerOption",
"path" : "Questionnaire.item.answerOption",
"short" : "Permitted answer",
"definition" : "One of the permitted answers for a \"choice\" or \"open-choice\" question.",
"comment" : "This element can be used when the value set machinery of answerValueSet is deemed too cumbersome or when there's a need to capture possible answers that are not codes.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Questionnaire.item.answerOption",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"condition" : ["que-4",
"que-5"],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A - MIF rather than RIM level"
}]
},
{
"id" : "Questionnaire.item.answerOption.id",
"path" : "Questionnaire.item.answerOption.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Questionnaire.item.answerOption.extension",
"path" : "Questionnaire.item.answerOption.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Questionnaire.item.answerOption.modifierExtension",
"path" : "Questionnaire.item.answerOption.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Questionnaire.item.answerOption.value[x]",
"path" : "Questionnaire.item.answerOption.value[x]",
"short" : "Answer value",
"definition" : "A potential answer that's allowed as the answer to this question.",
"comment" : "The data type of the value must agree with the item.type.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Questionnaire.item.answerOption.value[x]",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "integer"
},
{
"code" : "date"
},
{
"code" : "time"
},
{
"code" : "string"
},
{
"code" : "Coding"
},
{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "QuestionnaireQuestionOption"
}],
"strength" : "example",
"description" : "Allowed values to answer questions.",
"valueSet" : "http://hl7.org/fhir/ValueSet/questionnaire-answers"
},
"mapping" : [{
"identity" : "rim",
"map" : "N/A - MIF rather than RIM level"
}]
},
{
"id" : "Questionnaire.item.answerOption.initialSelected",
"path" : "Questionnaire.item.answerOption.initialSelected",
"short" : "Whether option is selected by default",
"definition" : "Indicates whether the answer value is selected when the list of possible answers is initially shown.",
"comment" : "Use this instead of initial[v] if answerValueSet is present.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Questionnaire.item.answerOption.initialSelected",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"meaningWhenMissing" : "Only selected items explicitly marked to be selected",
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A - MIF rather than RIM level"
}]
},
{
"id" : "Questionnaire.item.initial",
"path" : "Questionnaire.item.initial",
"short" : "Initial value(s) when item is first rendered",
"definition" : "One or more values that should be pre-populated in the answer when initially rendering the questionnaire for user input.",
"comment" : "The user is allowed to change the value and override the default (unless marked as read-only). If the user doesn't change the value, then this initial value will be persisted when the QuestionnaireResponse is initially created. Note that initial values can influence results. The data type of initial[x] must agree with the item.type, and only repeating items can have more then one initial value.",
"requirements" : "In some workflows, having defaults saves time.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Questionnaire.item.initial",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"condition" : ["que-8",
"que-13"],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A - MIF rather than RIM level"
}]
},
{
"id" : "Questionnaire.item.initial.id",
"path" : "Questionnaire.item.initial.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Questionnaire.item.initial.extension",
"path" : "Questionnaire.item.initial.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Questionnaire.item.initial.modifierExtension",
"path" : "Questionnaire.item.initial.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Questionnaire.item.initial.value[x]",
"path" : "Questionnaire.item.initial.value[x]",
"short" : "Actual value for initializing the question",
"definition" : "The actual value to for an initial answer.",
"comment" : "The type of the initial value must be consistent with the type of the item.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Questionnaire.item.initial.value[x]",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "boolean"
},
{
"code" : "decimal"
},
{
"code" : "integer"
},
{
"code" : "date"
},
{
"code" : "dateTime"
},
{
"code" : "time"
},
{
"code" : "string"
},
{
"code" : "uri"
},
{
"code" : "Attachment"
},
{
"code" : "Coding"
},
{
"code" : "Quantity"
},
{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "QuestionnaireQuestionOption2"
}],
"strength" : "example",
"description" : "Allowed values to answer questions.",
"valueSet" : "http://hl7.org/fhir/ValueSet/questionnaire-answers"
},
"mapping" : [{
"identity" : "rim",
"map" : "N/A - MIF rather than RIM level"
}]
},
{
"id" : "Questionnaire.item.item",
"path" : "Questionnaire.item.item",
"short" : "Nested questionnaire items",
"definition" : "Text, questions and other groups to be nested beneath a question or group.",
"comment" : "There is no specified limit to the depth of nesting. However, Questionnaire authors are encouraged to consider the impact on the user and user interface of overly deep nesting.",
"requirements" : "Reports can consist of complex nested groups.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Questionnaire.item.item",
"min" : 0,
"max" : "*"
},
"contentReference" : "#Questionnaire.item",
"condition" : ["que-1"],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=COMP].target"
}]
}]
},
"differential" : {
"element" : [{
"id" : "Questionnaire",
"path" : "Questionnaire",
"short" : "A structured set of questions",
"definition" : "A structured set of questions intended to guide the collection of answers from end-users. Questionnaires provide detailed control over order, presentation, phraseology and grouping to allow coherent, consistent data collection.",
"alias" : ["Form",
"CRF",
"Survey"],
"min" : 0,
"max" : "*",
"constraint" : [{
"key" : "que-2",
"severity" : "error",
"human" : "The link ids for groups and questions must be unique within the questionnaire",
"expression" : "descendants().linkId.isDistinct()",
"xpath" : "count(descendant::f:linkId/@value)=count(distinct-values(descendant::f:linkId/@value))"
},
{
"key" : "que-0",
"severity" : "warning",
"human" : "Name should be usable as an identifier for the module by machine processing applications such as code generation",
"expression" : "name.matches('[A-Z]([A-Za-z0-9_]){0,254}')",
"xpath" : "not(exists(f:name/@value)) or matches(f:name/@value, '[A-Z]([A-Za-z0-9_]){0,254}')"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Definition"
},
{
"identity" : "rim",
"map" : "Observation[moodCode=DEF]"
}]
},
{
"id" : "Questionnaire.url",
"path" : "Questionnaire.url",
"short" : "Canonical identifier for this questionnaire, represented as a URI (globally unique)",
"definition" : "An absolute URI that is used to identify this questionnaire when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this questionnaire is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the questionnaire is stored on different servers.",
"comment" : "The name of the referenced questionnaire can be conveyed using the http://hl7.org/fhir/StructureDefinition/display extension.",
"requirements" : "… This is the id that will be used to link a QuestionnaireResponse to the Questionnaire the response is for.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "uri"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.url"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "rim",
"map" : ".identifier[scope=BUSN;reliability=ISS]"
}]
},
{
"id" : "Questionnaire.identifier",
"path" : "Questionnaire.identifier",
"short" : "Additional identifier for the questionnaire",
"definition" : "A formal identifier that is used to identify this questionnaire when it is represented in other formats, or referenced in a specification, model, design or an instance.",
"comment" : "Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this questionnaire outside of FHIR, where it is not possible to use the logical URI.",
"requirements" : "Allows externally provided and/or usable business identifiers to be easily associated with the module.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Identifier"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.identifier"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "rim",
"map" : ".identifier"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "Questionnaire.version",
"path" : "Questionnaire.version",
"short" : "Business version of the questionnaire",
"definition" : "The identifier that is used to identify this version of the questionnaire when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the questionnaire author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.",
"comment" : "There may be different questionnaire instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the questionnaire with the format [url]|[version].",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.version"
},
{
"identity" : "w5",
"map" : "FiveWs.version"
},
{
"identity" : "rim",
"map" : "N/A (to add?)"
}]
},
{
"id" : "Questionnaire.name",
"path" : "Questionnaire.name",
"short" : "Name for this questionnaire (computer friendly)",
"definition" : "A natural language name identifying the questionnaire. This name should be usable as an identifier for the module by machine processing applications such as code generation.",
"comment" : "The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.",
"requirements" : "Support human navigation and code generation.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"condition" : ["inv-0"],
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Questionnaire.title",
"path" : "Questionnaire.title",
"short" : "Name for this questionnaire (human friendly)",
"definition" : "A short, descriptive, user-friendly title for the questionnaire.",
"comment" : "This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.title"
},
{
"identity" : "rim",
"map" : ".title"
}]
},
{
"id" : "Questionnaire.derivedFrom",
"path" : "Questionnaire.derivedFrom",
"short" : "Instantiates protocol or definition",
"definition" : "The URL of a Questionnaire that this Questionnaire is based on.",
"requirements" : "Allows a Questionnaire to be created based on another Questionnaire.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Questionnaire"]
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.derivedFrom"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=DRIV].target[classCode=OBS, moodCode=DEFN]"
}]
},
{
"id" : "Questionnaire.status",
"path" : "Questionnaire.status",
"short" : "draft | active | retired | unknown",
"definition" : "The status of this questionnaire. Enables tracking the life-cycle of the content.",
"comment" : "Allows filtering of questionnaires that are appropriate for use versus not.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isModifier" : true,
"isModifierReason" : "This is labeled as \"Is Modifier\" because applications should not use a retired {{title}} without due consideration",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "PublicationStatus"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "The lifecycle status of an artifact.",
"valueSet" : "http://hl7.org/fhir/ValueSet/publication-status|4.0.1"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.status"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
},
{
"identity" : "rim",
"map" : ".status"
}]
},
{
"id" : "Questionnaire.experimental",
"path" : "Questionnaire.experimental",
"short" : "For testing purposes, not real usage",
"definition" : "A Boolean value to indicate that this questionnaire is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.",
"comment" : "Allows filtering of questionnaires that are appropriate for use versus not.",
"requirements" : "Enables experimental content to be developed following the same lifecycle that would be used for a production-level questionnaire.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "boolean"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.experimental"
},
{
"identity" : "w5",
"map" : "FiveWs.class"
},
{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Questionnaire.subjectType",
"path" : "Questionnaire.subjectType",
"short" : "Resource that can be subject of QuestionnaireResponse",
"definition" : "The types of subjects that can be the subject of responses created for the questionnaire.",
"comment" : "If none are specified, then the subject is unlimited.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "code"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ResourceType"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "One of the resource types defined as part of this version of FHIR.",
"valueSet" : "http://hl7.org/fhir/ValueSet/resource-types|4.0.1"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.subject[x]"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=META].target[classCode=OBS, moodCode=DEFN, isCriterion=true].participation.role.classCode"
}]
},
{
"id" : "Questionnaire.date",
"path" : "Questionnaire.date",
"short" : "Date last changed",
"definition" : "The date (and optionally time) when the questionnaire was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the questionnaire changes.",
"comment" : "Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the questionnaire. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.",
"alias" : ["Revision Date"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "dateTime"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.date"
},
{
"identity" : "w5",
"map" : "FiveWs.recorded"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=AUT].time"
}]
},
{
"id" : "Questionnaire.publisher",
"path" : "Questionnaire.publisher",
"short" : "Name of the publisher (organization or individual)",
"definition" : "The name of the organization or individual that published the questionnaire.",
"comment" : "Usually an organization but may be an individual. The publisher (or steward) of the questionnaire is the organization or individual primarily responsible for the maintenance and upkeep of the questionnaire. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the questionnaire. This item SHOULD be populated unless the information is available from context.",
"requirements" : "Helps establish the \"authority/credibility\" of the questionnaire. May also allow for contact.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.publisher"
},
{
"identity" : "w5",
"map" : "FiveWs.witness"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=AUT].role"
}]
},
{
"id" : "Questionnaire.contact",
"path" : "Questionnaire.contact",
"short" : "Contact details for the publisher",
"definition" : "Contact details to assist a user in finding and communicating with the publisher.",
"comment" : "May be a web site, an email address, a telephone number, etc.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "ContactDetail"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.contact"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=CALLBCK].role"
}]
},
{
"id" : "Questionnaire.description",
"path" : "Questionnaire.description",
"short" : "Natural language description of the questionnaire",
"definition" : "A free text natural language description of the questionnaire from a consumer's perspective.",
"comment" : "This description can be used to capture details such as why the questionnaire was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the questionnaire as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the questionnaire is presumed to be the predominant language in the place the questionnaire was created).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "markdown"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.description"
},
{
"identity" : "rim",
"map" : ".text"
}]
},
{
"id" : "Questionnaire.useContext",
"path" : "Questionnaire.useContext",
"short" : "The context that the content is intended to support",
"definition" : "The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate questionnaire instances.",
"comment" : "When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.",
"requirements" : "Assist in searching for appropriate content.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "UsageContext"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.useContext"
},
{
"identity" : "rim",
"map" : "N/A (to add?)"
}]
},
{
"id" : "Questionnaire.jurisdiction",
"path" : "Questionnaire.jurisdiction",
"short" : "Intended jurisdiction for questionnaire (if applicable)",
"definition" : "A legal or geographic region in which the questionnaire is intended to be used.",
"comment" : "It may be possible for the questionnaire to be used in jurisdictions other than those for which it was originally designed or intended.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Jurisdiction"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "extensible",
"description" : "Countries and regions within which this artifact is targeted for use.",
"valueSet" : "http://hl7.org/fhir/ValueSet/jurisdiction"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.jurisdiction"
},
{
"identity" : "rim",
"map" : "N/A (to add?)"
}]
},
{
"id" : "Questionnaire.purpose",
"path" : "Questionnaire.purpose",
"short" : "Why this questionnaire is defined",
"definition" : "Explanation of why this questionnaire is needed and why it has been designed as it has.",
"comment" : "This element does not describe the usage of the questionnaire. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this questionnaire.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "markdown"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.purpose"
},
{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "rim",
"map" : ".reasonCode.text"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "Questionnaire.copyright",
"path" : "Questionnaire.copyright",
"short" : "Use and/or publishing restrictions",
"definition" : "A copyright statement relating to the questionnaire and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the questionnaire.",
"requirements" : "Consumers must be able to determine any legal restrictions on the use of the questionnaire and/or its content.",
"alias" : ["License",
"Restrictions"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "markdown"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.copyright"
},
{
"identity" : "rim",
"map" : "N/A (to add?)"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "Questionnaire.approvalDate",
"path" : "Questionnaire.approvalDate",
"short" : "When the questionnaire was approved by publisher",
"definition" : "The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.",
"comment" : "The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "date"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.approvalDate"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=\"SUBJ\"].act[classCode=CACT;moodCode=EVN;code=\"approval\"].effectiveTime"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "Questionnaire.lastReviewDate",
"path" : "Questionnaire.lastReviewDate",
"short" : "When the questionnaire was last reviewed",
"definition" : "The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.",
"comment" : "If specified, this date follows the original approval date.",
"requirements" : "Gives a sense of how \"current\" the content is. Resources that have not been reviewed in a long time may have a risk of being less appropriate/relevant.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "date"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.lastReviewDate"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=\"SUBJ\"; subsetCode=\"RECENT\"].act[classCode=CACT;moodCode=EVN;code=\"review\"].effectiveTime"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "Questionnaire.effectivePeriod",
"path" : "Questionnaire.effectivePeriod",
"short" : "When the questionnaire is expected to be used",
"definition" : "The period during which the questionnaire content was or is planned to be in active use.",
"comment" : "The effective period for a questionnaire determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 might be published in 2015.",
"requirements" : "Allows establishing a transition before a resource comes into effect and also allows for a sunsetting process when new versions of the questionnaire are or are expected to be used instead.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Period"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.effectivePeriod"
},
{
"identity" : "rim",
"map" : "N/A (to add?)"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "Questionnaire.code",
"path" : "Questionnaire.code",
"short" : "Concept that represents the overall questionnaire",
"definition" : "An identifier for this question or group of questions in a particular terminology such as LOINC.",
"requirements" : "Allows linking of the complete Questionnaire resources to formal terminologies. It's common for \"panels\" of questions to be identified by a code.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Coding"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "QuestionnaireConcept"
}],
"strength" : "example",
"description" : "Codes for questionnaires, groups and individual questions.",
"valueSet" : "http://hl7.org/fhir/ValueSet/questionnaire-questions"
},
"mapping" : [{
"identity" : "rim",
"map" : ".code"
}]
},
{
"id" : "Questionnaire.item",
"path" : "Questionnaire.item",
"short" : "Questions and sections within the Questionnaire",
"definition" : "A particular question, question grouping or display text that is part of the questionnaire.",
"comment" : "The content of the questionnaire is constructed from an ordered, hierarchical collection of items.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"condition" : ["que-3"],
"constraint" : [{
"key" : "que-9",
"severity" : "error",
"human" : "Read-only can't be specified for \"display\" items",
"expression" : "type!='display' or readOnly.empty()",
"xpath" : "not(f:type/@value=('group', 'display') and f:*[starts-with(local-name(.), 'initial')])"
},
{
"key" : "que-8",
"severity" : "error",
"human" : "Initial values can't be specified for groups or display items",
"expression" : "(type!='group' and type!='display') or initial.empty()",
"xpath" : "not(f:type/@value=('group', 'display') and f:*[starts-with(local-name(.), 'initial')])"
},
{
"key" : "que-6",
"severity" : "error",
"human" : "Required and repeat aren't permitted for display items",
"expression" : "type!='display' or (required.empty() and repeats.empty())",
"xpath" : "not(f:type/@value='display' and (f:required or f:repeats))"
},
{
"key" : "que-5",
"severity" : "error",
"human" : "Only 'choice' and 'open-choice' items can have answerValueSet",
"expression" : "(type ='choice' or type = 'open-choice' or type = 'decimal' or type = 'integer' or type = 'date' or type = 'dateTime' or type = 'time' or type = 'string' or type = 'quantity') or (answerValueSet.empty() and answerOption.empty())",
"xpath" : "f:type/@value=('choice','open-choice','decimal','integer','date','dateTime','time','string','quantity',') or not(f:answerOption or f:answerValueSet)"
},
{
"key" : "que-4",
"severity" : "error",
"human" : "A question cannot have both answerOption and answerValueSet",
"expression" : "answerOption.empty() or answerValueSet.empty()",
"xpath" : "not(f:answerValueSet and f:answerOption)"
},
{
"key" : "que-3",
"severity" : "error",
"human" : "Display items cannot have a \"code\" asserted",
"expression" : "type!='display' or code.empty()",
"xpath" : "not(f:type/@value='display' and f:code)"
},
{
"key" : "que-10",
"severity" : "error",
"human" : "Maximum length can only be declared for simple question types",
"expression" : "(type in ('boolean' | 'decimal' | 'integer' | 'string' | 'text' | 'url' | 'open-choice')) or maxLength.empty()",
"xpath" : "f:type/@value=('boolean', 'decimal', 'integer', 'open-choice', 'string', 'text', 'url') or not(f:maxLength)"
},
{
"key" : "que-1",
"severity" : "error",
"human" : "Group items must have nested items, display items cannot have nested items",
"expression" : "(type='group' implies item.empty().not()) and (type.trace('type')='display' implies item.trace('item').empty())",
"xpath" : "not((f:type/@value='group' and not(f:item)) or (f:type/@value='display' and f:item))"
},
{
"key" : "que-13",
"severity" : "error",
"human" : "Can only have multiple initial values for repeating items",
"expression" : "repeats=true or initial.count() <= 1",
"xpath" : "f:repeats/@value='true' or count(f:initial)<=1"
},
{
"key" : "que-11",
"severity" : "error",
"human" : "If one or more answerOption is present, initial[x] must be missing",
"expression" : "answerOption.empty() or initial.empty()",
"xpath" : "not(f:answerOption) or not(count(f:*[starts-with(local-name(.), 'initial')]))"
},
{
"key" : "que-12",
"severity" : "error",
"human" : "If there are more than one enableWhen, enableBehavior must be specified",
"expression" : "enableWhen.count() > 2 implies enableBehavior.exists()",
"xpath" : "not(f:answerOption) or not(count(f:*[starts-with(local-name(.), 'initial')]))"
}],
"mapping" : [{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=COMP].target[classCode=OBS, moodCode=DEF]"
}]
},
{
"id" : "Questionnaire.item.linkId",
"path" : "Questionnaire.item.linkId",
"short" : "Unique id for item in questionnaire",
"definition" : "An identifier that is unique within the Questionnaire allowing linkage to the equivalent item in a QuestionnaireResponse resource.",
"comment" : "This ''can'' be a meaningful identifier (e.g. a LOINC code) but is not intended to have any meaning. GUIDs or sequential numbers are appropriate here.",
"requirements" : "[QuestionnaireResponse](questionnaireresponse.html#) does not require omitted items to be included and may have some items that repeat, so linkage based on position alone is not sufficient.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "string"
}],
"mapping" : [{
"identity" : "rim",
"map" : ".id"
}]
},
{
"id" : "Questionnaire.item.definition",
"path" : "Questionnaire.item.definition",
"short" : "ElementDefinition - details for the item",
"definition" : "This element is a URI that refers to an [ElementDefinition](elementdefinition.html) that provides information about this item, including information that might otherwise be included in the instance of the Questionnaire resource. A detailed description of the construction of the URI is shown in Comments, below. If this element is present then the following element values MAY be derived from the Element Definition if the corresponding elements of this Questionnaire resource instance have no value:\n\n* code (ElementDefinition.code) \n* type (ElementDefinition.type) \n* required (ElementDefinition.min) \n* repeats (ElementDefinition.max) \n* maxLength (ElementDefinition.maxLength) \n* answerValueSet (ElementDefinition.binding)\n* options (ElementDefinition.binding).",
"comment" : "The uri refers to an ElementDefinition in a [StructureDefinition](structuredefinition.html#) and always starts with the [canonical URL](references.html#canonical) for the target resource. When referring to a StructureDefinition, a fragment identifier is used to specify the element definition by its id [Element.id](element-definitions.html#Element.id). E.g. http://hl7.org/fhir/StructureDefinition/Observation#Observation.value[x]. In the absence of a fragment identifier, the first/root element definition in the target is the matching element definition.",
"requirements" : "A common pattern is to define a set of data elements and then build multiple questionnaires for different circumstances to gather the data. This element provides traceability to the common definition and allows the content for the question to come from the underlying definition.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "uri"
}],
"mapping" : [{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=INST].target[classCode=OBS, moodCode=DEF]"
}]
},
{
"id" : "Questionnaire.item.code",
"path" : "Questionnaire.item.code",
"short" : "Corresponding concept for this item in a terminology",
"definition" : "A terminology code that corresponds to this group or question (e.g. a code from LOINC, which defines many questions and answers).",
"comment" : "The value may come from the ElementDefinition referred to by .definition.",
"requirements" : "Allows linking of groups of questions to formal terminologies.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Coding"
}],
"condition" : ["que-3"],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "QuestionnaireConcept"
}],
"strength" : "example",
"description" : "Codes for questionnaires, groups and individual questions.",
"valueSet" : "http://hl7.org/fhir/ValueSet/questionnaire-questions"
},
"mapping" : [{
"identity" : "rim",
"map" : ".code"
}]
},
{
"id" : "Questionnaire.item.prefix",
"path" : "Questionnaire.item.prefix",
"short" : "E.g. \"1(a)\", \"2.5.3\"",
"definition" : "A short label for a particular group, question or set of display text within the questionnaire used for reference by the individual completing the questionnaire.",
"comment" : "These are generally unique within a questionnaire, though this is not guaranteed. Some questionnaires may have multiple questions with the same label with logic to control which gets exposed. Typically, these won't be used for \"display\" items, though such use is not prohibited. Systems SHOULD NOT generate their own prefixes if prefixes are defined for any items within a Questionnaire.",
"requirements" : "Separating the label from the question text allows improved rendering. Also, instructions will often refer to specific prefixes, so there's a need for the questionnaire design to have control over what labels are used.",
"alias" : ["label"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"mapping" : [{
"identity" : "rim",
"map" : "Not supported"
}]
},
{
"id" : "Questionnaire.item.text",
"path" : "Questionnaire.item.text",
"short" : "Primary text for the item",
"definition" : "The name of a section, the text of a question or text content for a display item.",
"comment" : "When using this element to represent the name of a section, use group type item and also make sure to limit the text element to a short string suitable for display as a section heading. Group item instructions should be included as a display type item within the group.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"mapping" : [{
"identity" : "rim",
"map" : ".text"
}]
},
{
"id" : "Questionnaire.item.type",
"path" : "Questionnaire.item.type",
"short" : "group | display | boolean | decimal | integer | date | dateTime +",
"definition" : "The type of questionnaire item this is - whether text for display, a grouping of other items or a particular type of data to be captured (string, integer, coded choice, etc.).",
"comment" : "Additional constraints on the type of answer can be conveyed by extensions. The value may come from the ElementDefinition referred to by .definition.",
"requirements" : "Defines the format in which the user is to be prompted for the answer.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "QuestionnaireItemType"
}],
"strength" : "required",
"description" : "Distinguishes groups from questions and display text and indicates data type for questions.",
"valueSet" : "http://hl7.org/fhir/ValueSet/item-type|4.0.1"
},
"mapping" : [{
"identity" : "rim",
"map" : "N/A - MIF rather than RIM level"
}]
},
{
"id" : "Questionnaire.item.enableWhen",
"path" : "Questionnaire.item.enableWhen",
"short" : "Only allow data when",
"definition" : "A constraint indicating that this item should only be enabled (displayed/allow answers to be captured) when the specified condition is true.",
"comment" : "If multiple repetitions of this extension are present, the item should be enabled when the condition for *any* of the repetitions is true. I.e. treat \"enableWhen\"s as being joined by an \"or\" clause. This element is a modifier because if enableWhen is present for an item, \"required\" is ignored unless one of the enableWhen conditions is met. When an item is disabled, all of its descendants are disabled, regardless of what their own enableWhen logic might evaluate to.",
"requirements" : "Allows questionnaires to adapt based on answers to other questions. E.g. If physical gender is specified as a male, no need to capture pregnancy history. Also allows conditional display of instructions or groups of questions.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "que-7",
"severity" : "error",
"human" : "If the operator is 'exists', the value must be a boolean",
"expression" : "operator = 'exists' implies (answer is Boolean)",
"xpath" : "f:operator/@value != 'exists' or exists(f:answerBoolean)"
}],
"isModifier" : true,
"isModifierReason" : "If enableWhen is present and the condition evaluates to false, then the Questionnaire behaves as though the elements weren't actually present",
"mapping" : [{
"identity" : "rim",
"map" : "N/A - MIF rather than RIM level"
}]
},
{
"id" : "Questionnaire.item.enableWhen.question",
"path" : "Questionnaire.item.enableWhen.question",
"short" : "Question that determines whether item is enabled",
"definition" : "The linkId for the question whose answer (or lack of answer) governs whether this item is enabled.",
"comment" : "If multiple question occurrences are present for the same question (same linkId), then this refers to the nearest question occurrence reachable by tracing first the \"ancestor\" axis and then the \"preceding\" axis and then the \"following\" axis.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "string"
}],
"mapping" : [{
"identity" : "rim",
"map" : "N/A - MIF rather than RIM level"
}]
},
{
"id" : "Questionnaire.item.enableWhen.operator",
"path" : "Questionnaire.item.enableWhen.operator",
"short" : "exists | = | != | > | < | >= | <=",
"definition" : "Specifies the criteria by which the question is enabled.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "QuestionnaireItemOperator"
}],
"strength" : "required",
"description" : "The criteria by which a question is enabled.",
"valueSet" : "http://hl7.org/fhir/ValueSet/questionnaire-enable-operator|4.0.1"
},
"mapping" : [{
"identity" : "rim",
"map" : "N/A - MIF rather than RIM level"
}]
},
{
"id" : "Questionnaire.item.enableWhen.answer[x]",
"path" : "Questionnaire.item.enableWhen.answer[x]",
"short" : "Value for question comparison based on operator",
"definition" : "A value that the referenced question is tested using the specified operator in order for the item to be enabled.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "boolean"
},
{
"code" : "decimal"
},
{
"code" : "integer"
},
{
"code" : "date"
},
{
"code" : "dateTime"
},
{
"code" : "time"
},
{
"code" : "string"
},
{
"code" : "Coding"
},
{
"code" : "Quantity"
},
{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"condition" : ["que-7"],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "QuestionnaireQuestionOption3"
}],
"strength" : "example",
"description" : "Allowed values to answer questions.",
"valueSet" : "http://hl7.org/fhir/ValueSet/questionnaire-answers"
},
"mapping" : [{
"identity" : "rim",
"map" : "N/A - MIF rather than RIM level"
}]
},
{
"id" : "Questionnaire.item.enableBehavior",
"path" : "Questionnaire.item.enableBehavior",
"short" : "all | any",
"definition" : "Controls how multiple enableWhen values are interpreted - whether all or any must be true.",
"comment" : "This element must be specified if more than one enableWhen value is provided.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "code"
}],
"condition" : ["que-12"],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "EnableWhenBehavior"
}],
"strength" : "required",
"description" : "Controls how multiple enableWhen values are interpreted - whether all or any must be true.",
"valueSet" : "http://hl7.org/fhir/ValueSet/questionnaire-enable-behavior|4.0.1"
},
"mapping" : [{
"identity" : "rim",
"map" : "N/A - MIF rather than RIM level"
}]
},
{
"id" : "Questionnaire.item.required",
"path" : "Questionnaire.item.required",
"short" : "Whether the item must be included in data results",
"definition" : "An indication, if true, that the item must be present in a \"completed\" QuestionnaireResponse. If false, the item may be skipped when answering the questionnaire.",
"comment" : "Questionnaire.item.required only has meaning for elements that are conditionally enabled with enableWhen if the condition evaluates to true. If an item that contains other items is marked as required, that does not automatically make the contained elements required (though required groups must contain at least one child element). The value may come from the ElementDefinition referred to by .definition.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "boolean"
}],
"meaningWhenMissing" : "Items are generally assumed not to be required unless explicitly specified. Systems SHOULD always populate this value",
"condition" : ["que-6"],
"mapping" : [{
"identity" : "rim",
"map" : "N/A - MIF rather than RIM level"
}]
},
{
"id" : "Questionnaire.item.repeats",
"path" : "Questionnaire.item.repeats",
"short" : "Whether the item may repeat",
"definition" : "An indication, if true, that the item may occur multiple times in the response, collecting multiple answers for questions or multiple sets of answers for groups.",
"comment" : "If a question is marked as repeats=true, then multiple answers can be provided for the question in the corresponding QuestionnaireResponse. When rendering the questionnaire, it is up to the rendering software whether to render the question text for each answer repetition (i.e. \"repeat the question\") or to simply allow entry/selection of multiple answers for the question (repeat the answers). Which is most appropriate visually may depend on the type of answer as well as whether there are nested items.\n\nThe resulting QuestionnaireResponse will be populated the same way regardless of rendering - one 'question' item with multiple answer values.\n\n The value may come from the ElementDefinition referred to by .definition.",
"requirements" : "Items may be used to create set of (related) questions that can be repeated to give multiple answers to such a set.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "boolean"
}],
"meaningWhenMissing" : "Items are generally assumed not to repeat unless explicitly specified. Systems SHOULD always populate this value",
"condition" : ["que-6"],
"mapping" : [{
"identity" : "rim",
"map" : "N/A - MIF rather than RIM level"
}]
},
{
"id" : "Questionnaire.item.readOnly",
"path" : "Questionnaire.item.readOnly",
"short" : "Don't allow human editing",
"definition" : "An indication, when true, that the value cannot be changed by a human respondent to the Questionnaire.",
"comment" : "The value of readOnly elements can be established by asserting extensions for defaultValues, linkages that support pre-population and/or extensions that support calculation based on other answers.",
"requirements" : "Allows certain information to be phrased (and rendered) as a question and an answer, while keeping users from changing it. May also be useful for preventing changes to pre-populated portions of a questionnaire, for calculated values, etc.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "boolean"
}],
"condition" : ["que-9"],
"mapping" : [{
"identity" : "rim",
"map" : "N/A - MIF rather than RIM level"
}]
},
{
"id" : "Questionnaire.item.maxLength",
"path" : "Questionnaire.item.maxLength",
"short" : "No more than this many characters",
"definition" : "The maximum number of characters that are permitted in the answer to be considered a \"valid\" QuestionnaireResponse.",
"comment" : "For base64binary, reflects the number of characters representing the encoded data, not the number of bytes of the binary data. The value may come from the ElementDefinition referred to by .definition.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "integer"
}],
"condition" : ["que-10"],
"mapping" : [{
"identity" : "v2",
"map" : "N/A"
},
{
"identity" : "rim",
"map" : "N/A - MIF rather than RIM level"
}]
},
{
"id" : "Questionnaire.item.answerValueSet",
"path" : "Questionnaire.item.answerValueSet",
"short" : "Valueset containing permitted answers",
"definition" : "A reference to a value set containing a list of codes representing permitted answers for a \"choice\" or \"open-choice\" question.",
"comment" : "LOINC defines many useful value sets for questionnaire responses. See [LOINC Answer Lists](loinc.html#alist). The value may come from the ElementDefinition referred to by .definition.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ValueSet"]
}],
"condition" : ["que-4",
"que-5"],
"mapping" : [{
"identity" : "rim",
"map" : "N/A - MIF rather than RIM level"
}]
},
{
"id" : "Questionnaire.item.answerOption",
"path" : "Questionnaire.item.answerOption",
"short" : "Permitted answer",
"definition" : "One of the permitted answers for a \"choice\" or \"open-choice\" question.",
"comment" : "This element can be used when the value set machinery of answerValueSet is deemed too cumbersome or when there's a need to capture possible answers that are not codes.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"condition" : ["que-4",
"que-5"],
"mapping" : [{
"identity" : "rim",
"map" : "N/A - MIF rather than RIM level"
}]
},
{
"id" : "Questionnaire.item.answerOption.value[x]",
"path" : "Questionnaire.item.answerOption.value[x]",
"short" : "Answer value",
"definition" : "A potential answer that's allowed as the answer to this question.",
"comment" : "The data type of the value must agree with the item.type.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "integer"
},
{
"code" : "date"
},
{
"code" : "time"
},
{
"code" : "string"
},
{
"code" : "Coding"
},
{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "QuestionnaireQuestionOption"
}],
"strength" : "example",
"description" : "Allowed values to answer questions.",
"valueSet" : "http://hl7.org/fhir/ValueSet/questionnaire-answers"
},
"mapping" : [{
"identity" : "rim",
"map" : "N/A - MIF rather than RIM level"
}]
},
{
"id" : "Questionnaire.item.answerOption.initialSelected",
"path" : "Questionnaire.item.answerOption.initialSelected",
"short" : "Whether option is selected by default",
"definition" : "Indicates whether the answer value is selected when the list of possible answers is initially shown.",
"comment" : "Use this instead of initial[v] if answerValueSet is present.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "boolean"
}],
"meaningWhenMissing" : "Only selected items explicitly marked to be selected",
"mapping" : [{
"identity" : "rim",
"map" : "N/A - MIF rather than RIM level"
}]
},
{
"id" : "Questionnaire.item.initial",
"path" : "Questionnaire.item.initial",
"short" : "Initial value(s) when item is first rendered",
"definition" : "One or more values that should be pre-populated in the answer when initially rendering the questionnaire for user input.",
"comment" : "The user is allowed to change the value and override the default (unless marked as read-only). If the user doesn't change the value, then this initial value will be persisted when the QuestionnaireResponse is initially created. Note that initial values can influence results. The data type of initial[x] must agree with the item.type, and only repeating items can have more then one initial value.",
"requirements" : "In some workflows, having defaults saves time.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"condition" : ["que-8",
"que-13"],
"mapping" : [{
"identity" : "rim",
"map" : "N/A - MIF rather than RIM level"
}]
},
{
"id" : "Questionnaire.item.initial.value[x]",
"path" : "Questionnaire.item.initial.value[x]",
"short" : "Actual value for initializing the question",
"definition" : "The actual value to for an initial answer.",
"comment" : "The type of the initial value must be consistent with the type of the item.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "boolean"
},
{
"code" : "decimal"
},
{
"code" : "integer"
},
{
"code" : "date"
},
{
"code" : "dateTime"
},
{
"code" : "time"
},
{
"code" : "string"
},
{
"code" : "uri"
},
{
"code" : "Attachment"
},
{
"code" : "Coding"
},
{
"code" : "Quantity"
},
{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "QuestionnaireQuestionOption2"
}],
"strength" : "example",
"description" : "Allowed values to answer questions.",
"valueSet" : "http://hl7.org/fhir/ValueSet/questionnaire-answers"
},
"mapping" : [{
"identity" : "rim",
"map" : "N/A - MIF rather than RIM level"
}]
},
{
"id" : "Questionnaire.item.item",
"path" : "Questionnaire.item.item",
"short" : "Nested questionnaire items",
"definition" : "Text, questions and other groups to be nested beneath a question or group.",
"comment" : "There is no specified limit to the depth of nesting. However, Questionnaire authors are encouraged to consider the impact on the user and user interface of overly deep nesting.",
"requirements" : "Reports can consist of complex nested groups.",
"min" : 0,
"max" : "*",
"contentReference" : "#Questionnaire.item",
"condition" : ["que-1"],
"mapping" : [{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=COMP].target"
}]
}]
}
}
},
{
"fullUrl" : "http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse",
"resource" : {
"resourceType" : "StructureDefinition",
"id" : "QuestionnaireResponse",
"meta" : {
"lastUpdated" : "2019-11-01T09:29:23.356+11:00"
},
"text" : {
"status" : "generated",
"div" : "Name Flags Card. Type Description & Constraints QuestionnaireResponse TU DomainResource A structured set of questions and their answers
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension identifier Σ 0..1 Identifier Unique id for this set of answers basedOn Σ 0..* Reference(CarePlan | ServiceRequest) Request fulfilled by this QuestionnaireResponse
partOf Σ 0..* Reference(Observation | Procedure) Part of this action
questionnaire Σ 0..1 canonical(Questionnaire) Form being answered status ?!Σ 1..1 code in-progress | completed | amended | entered-in-error | stopped
QuestionnaireResponseStatus (Required) subject Σ 0..1 Reference(Any) The subject of the questions encounter Σ 0..1 Reference(Encounter) Encounter created as part of authored Σ 0..1 dateTime Date the answers were gathered author Σ 0..1 Reference(Device | Practitioner | PractitionerRole | Patient | RelatedPerson | Organization) Person who received and recorded the answers source Σ 0..1 Reference(Patient | Practitioner | PractitionerRole | RelatedPerson) The person who answered the questions item I 0..* BackboneElement Groups and questions
+ Rule: Nested item can't be beneath both item and answer
linkId 1..1 string Pointer to specific item from Questionnaire definition 0..1 uri ElementDefinition - details for the item text 0..1 string Name for group or question text answer 0..* BackboneElement The response(s) to the question
value[x] 0..1 Single-valued answer to the question
Questionnaire Answer Codes (Example) valueBoolean boolean valueDecimal decimal valueInteger integer valueDate date valueDateTime dateTime valueTime time valueString string valueUri uri valueAttachment Attachment valueCoding Coding valueQuantity Quantity valueReference Reference(Any) item 0..* see item Nested groups and questions
item 0..* see item Nested questionnaire response items
Documentation for this format
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Clinical.Diagnostics"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 3
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "patient"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "fhir"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse",
"version" : "4.0.1",
"name" : "QuestionnaireResponse",
"status" : "draft",
"date" : "2019-11-01T09:29:23+11:00",
"publisher" : "Health Level Seven International (FHIR Infrastructure)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/fiwg/index.cfm"
}]
}],
"description" : "A structured set of questions and their answers. The questions are ordered and grouped into coherent subsets, corresponding to the structure of the grouping of the questionnaire being responded to.",
"purpose" : "To support structured, hierarchical reporting of data gathered using digital forms and other questionnaires.",
"fhirVersion" : "4.0.1",
"mapping" : [{
"identity" : "workflow",
"uri" : "http://hl7.org/fhir/workflow",
"name" : "Workflow Pattern"
},
{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/fivews",
"name" : "FiveWs Pattern Mapping"
}],
"kind" : "resource",
"abstract" : false,
"type" : "QuestionnaireResponse",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "QuestionnaireResponse",
"path" : "QuestionnaireResponse",
"short" : "A structured set of questions and their answers",
"definition" : "A structured set of questions and their answers. The questions are ordered and grouped into coherent subsets, corresponding to the structure of the grouping of the questionnaire being responded to.",
"comment" : "The QuestionnaireResponse contains enough information about the questions asked and their organization that it can be interpreted somewhat independently from the Questionnaire it is based on. I.e. You don't need access to the Questionnaire in order to extract basic information from a QuestionnaireResponse.",
"alias" : ["Form",
"QuestionnaireAnswers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "QuestionnaireResponse",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "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",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.`div`.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "workflow",
"map" : "Event"
},
{
"identity" : "rim",
"map" : "Observation[moodCode=EVN]"
}]
},
{
"id" : "QuestionnaireResponse.id",
"path" : "QuestionnaireResponse.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "QuestionnaireResponse.meta",
"path" : "QuestionnaireResponse.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "QuestionnaireResponse.implicitRules",
"path" : "QuestionnaireResponse.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "QuestionnaireResponse.language",
"path" : "QuestionnaireResponse.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "QuestionnaireResponse.text",
"path" : "QuestionnaireResponse.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "QuestionnaireResponse.contained",
"path" : "QuestionnaireResponse.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "QuestionnaireResponse.extension",
"path" : "QuestionnaireResponse.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "QuestionnaireResponse.modifierExtension",
"path" : "QuestionnaireResponse.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "QuestionnaireResponse.identifier",
"path" : "QuestionnaireResponse.identifier",
"short" : "Unique id for this set of answers",
"definition" : "A business identifier assigned to a particular completed (or partially completed) questionnaire.",
"requirements" : "Used for tracking, registration and other business purposes.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "QuestionnaireResponse.identifier",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Identifier"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.identifier"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "rim",
"map" : ".id"
}]
},
{
"id" : "QuestionnaireResponse.basedOn",
"path" : "QuestionnaireResponse.basedOn",
"short" : "Request fulfilled by this QuestionnaireResponse",
"definition" : "The order, proposal or plan that is fulfilled in whole or in part by this QuestionnaireResponse. For example, a ServiceRequest seeking an intake assessment or a decision support recommendation to assess for post-partum depression.",
"requirements" : "Supports traceability of responsibility for the action and allows linkage of an action to the recommendations acted upon.",
"alias" : ["order"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "QuestionnaireResponse.basedOn",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/CarePlan",
"http://hl7.org/fhir/StructureDefinition/ServiceRequest"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.basedOn"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=FLFS].target"
}]
},
{
"id" : "QuestionnaireResponse.partOf",
"path" : "QuestionnaireResponse.partOf",
"short" : "Part of this action",
"definition" : "A procedure or observation that this questionnaire was performed as part of the execution of. For example, the surgery a checklist was executed as part of.",
"comment" : "Composition of questionnaire responses will be handled by the parent questionnaire having answers that reference the child questionnaire. For relationships to referrals, and other types of requests, use basedOn.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "QuestionnaireResponse.partOf",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Observation",
"http://hl7.org/fhir/StructureDefinition/Procedure"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.partOf"
},
{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=COMP].source[moodCode=EVN]"
}]
},
{
"id" : "QuestionnaireResponse.questionnaire",
"path" : "QuestionnaireResponse.questionnaire",
"short" : "Form being answered",
"definition" : "The Questionnaire that defines and organizes the questions for which answers are being provided.",
"comment" : "If a QuestionnaireResponse references a Questionnaire, then the QuestionnaireResponse structure must be consistent with the Questionnaire (i.e. questions must be organized into the same groups, nested questions must still be nested, etc.).",
"requirements" : "Needed to allow editing of the questionnaire response in a manner that enforces the constraints of the original form.",
"alias" : ["Form"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "QuestionnaireResponse.questionnaire",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Questionnaire"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.instantiates"
},
{
"identity" : "rim",
"map" : "./outboundRelationship[typeCode=INST]/target[classCode=OBS, moodCode=DEFN]"
}]
},
{
"id" : "QuestionnaireResponse.status",
"path" : "QuestionnaireResponse.status",
"short" : "in-progress | completed | amended | entered-in-error | stopped",
"definition" : "The position of the questionnaire response within its overall lifecycle.",
"comment" : "This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.",
"requirements" : "The information on Questionnaire resources may possibly be gathered during multiple sessions and altered after considered being finished.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "QuestionnaireResponse.status",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "QuestionnaireResponseStatus"
}],
"strength" : "required",
"description" : "Lifecycle status of the questionnaire response.",
"valueSet" : "http://hl7.org/fhir/ValueSet/questionnaire-answers-status|4.0.1"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.status"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
},
{
"identity" : "rim",
"map" : ".statusCode (also whether there's a revisionControlAct - and possibly mood to distinguish \"in-progress\" from \"published)"
}]
},
{
"id" : "QuestionnaireResponse.subject",
"path" : "QuestionnaireResponse.subject",
"short" : "The subject of the questions",
"definition" : "The subject of the questionnaire response. This could be a patient, organization, practitioner, device, etc. This is who/what the answers apply to, but is not necessarily the source of information.",
"comment" : "If the Questionnaire declared a subjectType, the resource pointed to by this element must be an instance of one of the listed types.",
"requirements" : "Allows linking the answers to the individual the answers describe. May also affect access control.",
"alias" : ["Patient",
"Focus"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "QuestionnaireResponse.subject",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.subject"
},
{
"identity" : "w5",
"map" : "FiveWs.subject[x]"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=SBJ].role"
},
{
"identity" : "w5",
"map" : "FiveWs.subject"
}]
},
{
"id" : "QuestionnaireResponse.encounter",
"path" : "QuestionnaireResponse.encounter",
"short" : "Encounter created as part of",
"definition" : "The Encounter during which this questionnaire response was created or to which the creation of this record is tightly associated.",
"comment" : "This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter. A questionnaire that was initiated during an encounter but not fully completed during the encounter would still generally be associated with the encounter.",
"requirements" : "Provides context for the information that was captured. May also affect access control.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "QuestionnaireResponse.encounter",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Encounter"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.encounter"
},
{
"identity" : "w5",
"map" : "FiveWs.context"
},
{
"identity" : "rim",
"map" : ".inboundRelationship(typeCode=COMP].source[classCode<=PCPR, moodCode=EVN]"
}]
},
{
"id" : "QuestionnaireResponse.authored",
"path" : "QuestionnaireResponse.authored",
"short" : "Date the answers were gathered",
"definition" : "The date and/or time that this set of answers were last changed.",
"comment" : "May be different from the lastUpdateTime of the resource itself, because that reflects when the data was known to the server, not when the data was captured.\n\nThis element is optional to allow for systems that might not know the value, however it SHOULD be populated if possible.",
"requirements" : "Clinicians need to be able to check the date that the information in the questionnaire was collected, to derive the context of the answers.",
"alias" : ["Date Created",
"Date published",
"Date Issued",
"Date updated"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "QuestionnaireResponse.authored",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.occurrence[x]"
},
{
"identity" : "w5",
"map" : "FiveWs.recorded"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=AUT].time"
}]
},
{
"id" : "QuestionnaireResponse.author",
"path" : "QuestionnaireResponse.author",
"short" : "Person who received and recorded the answers",
"definition" : "Person who received the answers to the questions in the QuestionnaireResponse and recorded them in the system.",
"comment" : "Mapping a subject's answers to multiple choice options and determining what to put in the textual answer is a matter of interpretation. Authoring by device would indicate that some portion of the questionnaire had been auto-populated.",
"requirements" : "Need to know who interpreted the subject's answers to the questions in the questionnaire, and selected the appropriate options for answers.",
"alias" : ["Laboratory",
"Service",
"Practitioner",
"Department",
"Company",
"Performer"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "QuestionnaireResponse.author",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Device",
"http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson",
"http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.performer"
},
{
"identity" : "w5",
"map" : "FiveWs.author"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=AUT].role"
}]
},
{
"id" : "QuestionnaireResponse.source",
"path" : "QuestionnaireResponse.source",
"short" : "The person who answered the questions",
"definition" : "The person who answered the questions about the subject.",
"comment" : "If not specified, no inference can be made about who provided the data.",
"requirements" : "When answering questions about a subject that is minor, incapable of answering or an animal, another human source may answer the questions.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "QuestionnaireResponse.source",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.source"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=INF].role"
}]
},
{
"id" : "QuestionnaireResponse.item",
"path" : "QuestionnaireResponse.item",
"short" : "Groups and questions",
"definition" : "A group or question item from the original questionnaire for which answers are provided.",
"comment" : "Groups cannot have answers and therefore must nest directly within item. When dealing with questions, nesting must occur within each answer because some questions may have multiple answers (and the nesting occurs for each answer).",
"min" : 0,
"max" : "*",
"base" : {
"path" : "QuestionnaireResponse.item",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "qrs-1",
"severity" : "error",
"human" : "Nested item can't be beneath both item and answer",
"expression" : "(answer.exists() and item.exists()).not()",
"xpath" : "not(exists(f:answer) and exists(f:item))"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=COMP].target[classCode=OBS, moodCode=EVN]"
}]
},
{
"id" : "QuestionnaireResponse.item.id",
"path" : "QuestionnaireResponse.item.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "QuestionnaireResponse.item.extension",
"path" : "QuestionnaireResponse.item.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "QuestionnaireResponse.item.modifierExtension",
"path" : "QuestionnaireResponse.item.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "QuestionnaireResponse.item.linkId",
"path" : "QuestionnaireResponse.item.linkId",
"short" : "Pointer to specific item from Questionnaire",
"definition" : "The item from the Questionnaire that corresponds to this item in the QuestionnaireResponse resource.",
"requirements" : "Items can repeat in the answers, so a direct 1..1 correspondence by position might not exist - requiring correspondence by identifier.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "QuestionnaireResponse.item.linkId",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=DEFN].target[classCode=OBS, moodCode=DEFN].id"
}]
},
{
"id" : "QuestionnaireResponse.item.definition",
"path" : "QuestionnaireResponse.item.definition",
"short" : "ElementDefinition - details for the item",
"definition" : "A reference to an [ElementDefinition](elementdefinition.html) that provides the details for the item.",
"comment" : "The ElementDefinition must be in a [StructureDefinition](structuredefinition.html#), and must have a fragment identifier that identifies the specific data element by its id (Element.id). E.g. http://hl7.org/fhir/StructureDefinition/Observation#Observation.value[x].\n\nThere is no need for this element if the item pointed to by the linkId has a definition listed.",
"requirements" : "A common pattern is to define a set of data elements, and then build multiple different questionnaires for different circumstances to gather the data. This element provides traceability to the common definition.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "QuestionnaireResponse.item.definition",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=DEFN].target[classCode=OBS, moodCode=DEFN].code"
}]
},
{
"id" : "QuestionnaireResponse.item.text",
"path" : "QuestionnaireResponse.item.text",
"short" : "Name for group or question text",
"definition" : "Text that is displayed above the contents of the group or as the text of the question being answered.",
"requirements" : "Allows the questionnaire response to be read without access to the questionnaire.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "QuestionnaireResponse.item.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".text"
}]
},
{
"id" : "QuestionnaireResponse.item.answer",
"path" : "QuestionnaireResponse.item.answer",
"short" : "The response(s) to the question",
"definition" : "The respondent's answer(s) to the question.",
"comment" : "The value is nested because we cannot have a repeating structure that has variable type.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "QuestionnaireResponse.item.answer",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".value[type=LIST_ANY]"
}]
},
{
"id" : "QuestionnaireResponse.item.answer.id",
"path" : "QuestionnaireResponse.item.answer.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "QuestionnaireResponse.item.answer.extension",
"path" : "QuestionnaireResponse.item.answer.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "QuestionnaireResponse.item.answer.modifierExtension",
"path" : "QuestionnaireResponse.item.answer.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "QuestionnaireResponse.item.answer.value[x]",
"path" : "QuestionnaireResponse.item.answer.value[x]",
"short" : "Single-valued answer to the question",
"definition" : "The answer (or one of the answers) provided by the respondent to the question.",
"comment" : "More complex structures (Attachment, Resource and Quantity) will typically be limited to electronic forms that can expose an appropriate user interface to capture the components and enforce the constraints of a complex data type. Additional complex types can be introduced through extensions. Must match the datatype specified by Questionnaire.item.type in the corresponding Questionnaire.",
"requirements" : "Ability to retain a single-valued answer to a question.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "QuestionnaireResponse.item.answer.value[x]",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
},
{
"code" : "decimal"
},
{
"code" : "integer"
},
{
"code" : "date"
},
{
"code" : "dateTime"
},
{
"code" : "time"
},
{
"code" : "string"
},
{
"code" : "uri"
},
{
"code" : "Attachment"
},
{
"code" : "Coding"
},
{
"code" : "Quantity"
},
{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "QuestionnaireAnswer"
}],
"strength" : "example",
"description" : "Code indicating the response provided for a question.",
"valueSet" : "http://hl7.org/fhir/ValueSet/questionnaire-answers"
},
"mapping" : [{
"identity" : "rim",
"map" : ".item"
}]
},
{
"id" : "QuestionnaireResponse.item.answer.item",
"path" : "QuestionnaireResponse.item.answer.item",
"short" : "Nested groups and questions",
"definition" : "Nested groups and/or questions found within this particular answer.",
"requirements" : "It is useful to have \"sub-questions\", questions which normally appear when certain answers are given and which collect additional details.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "QuestionnaireResponse.item.answer.item",
"min" : 0,
"max" : "*"
},
"contentReference" : "#QuestionnaireResponse.item",
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=COMP].target[classCode=OBS, moodCode=EVN]"
}]
},
{
"id" : "QuestionnaireResponse.item.item",
"path" : "QuestionnaireResponse.item.item",
"short" : "Nested questionnaire response items",
"definition" : "Questions or sub-groups nested beneath a question or group.",
"requirements" : "Reports can consist of complex nested groups.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "QuestionnaireResponse.item.item",
"min" : 0,
"max" : "*"
},
"contentReference" : "#QuestionnaireResponse.item",
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=COMP].target[classCode=OBS, moodCode=EVN]"
}]
}]
},
"differential" : {
"element" : [{
"id" : "QuestionnaireResponse",
"path" : "QuestionnaireResponse",
"short" : "A structured set of questions and their answers",
"definition" : "A structured set of questions and their answers. The questions are ordered and grouped into coherent subsets, corresponding to the structure of the grouping of the questionnaire being responded to.",
"comment" : "The QuestionnaireResponse contains enough information about the questions asked and their organization that it can be interpreted somewhat independently from the Questionnaire it is based on. I.e. You don't need access to the Questionnaire in order to extract basic information from a QuestionnaireResponse.",
"alias" : ["Form",
"QuestionnaireAnswers"],
"min" : 0,
"max" : "*",
"mapping" : [{
"identity" : "workflow",
"map" : "Event"
},
{
"identity" : "rim",
"map" : "Observation[moodCode=EVN]"
}]
},
{
"id" : "QuestionnaireResponse.identifier",
"path" : "QuestionnaireResponse.identifier",
"short" : "Unique id for this set of answers",
"definition" : "A business identifier assigned to a particular completed (or partially completed) questionnaire.",
"requirements" : "Used for tracking, registration and other business purposes.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Identifier"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.identifier"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "rim",
"map" : ".id"
}]
},
{
"id" : "QuestionnaireResponse.basedOn",
"path" : "QuestionnaireResponse.basedOn",
"short" : "Request fulfilled by this QuestionnaireResponse",
"definition" : "The order, proposal or plan that is fulfilled in whole or in part by this QuestionnaireResponse. For example, a ServiceRequest seeking an intake assessment or a decision support recommendation to assess for post-partum depression.",
"requirements" : "Supports traceability of responsibility for the action and allows linkage of an action to the recommendations acted upon.",
"alias" : ["order"],
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/CarePlan",
"http://hl7.org/fhir/StructureDefinition/ServiceRequest"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.basedOn"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=FLFS].target"
}]
},
{
"id" : "QuestionnaireResponse.partOf",
"path" : "QuestionnaireResponse.partOf",
"short" : "Part of this action",
"definition" : "A procedure or observation that this questionnaire was performed as part of the execution of. For example, the surgery a checklist was executed as part of.",
"comment" : "Composition of questionnaire responses will be handled by the parent questionnaire having answers that reference the child questionnaire. For relationships to referrals, and other types of requests, use basedOn.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Observation",
"http://hl7.org/fhir/StructureDefinition/Procedure"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.partOf"
},
{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=COMP].source[moodCode=EVN]"
}]
},
{
"id" : "QuestionnaireResponse.questionnaire",
"path" : "QuestionnaireResponse.questionnaire",
"short" : "Form being answered",
"definition" : "The Questionnaire that defines and organizes the questions for which answers are being provided.",
"comment" : "If a QuestionnaireResponse references a Questionnaire, then the QuestionnaireResponse structure must be consistent with the Questionnaire (i.e. questions must be organized into the same groups, nested questions must still be nested, etc.).",
"requirements" : "Needed to allow editing of the questionnaire response in a manner that enforces the constraints of the original form.",
"alias" : ["Form"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Questionnaire"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.instantiates"
},
{
"identity" : "rim",
"map" : "./outboundRelationship[typeCode=INST]/target[classCode=OBS, moodCode=DEFN]"
}]
},
{
"id" : "QuestionnaireResponse.status",
"path" : "QuestionnaireResponse.status",
"short" : "in-progress | completed | amended | entered-in-error | stopped",
"definition" : "The position of the questionnaire response within its overall lifecycle.",
"comment" : "This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.",
"requirements" : "The information on Questionnaire resources may possibly be gathered during multiple sessions and altered after considered being finished.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isModifier" : true,
"isModifierReason" : "This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "QuestionnaireResponseStatus"
}],
"strength" : "required",
"description" : "Lifecycle status of the questionnaire response.",
"valueSet" : "http://hl7.org/fhir/ValueSet/questionnaire-answers-status|4.0.1"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.status"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
},
{
"identity" : "rim",
"map" : ".statusCode (also whether there's a revisionControlAct - and possibly mood to distinguish \"in-progress\" from \"published)"
}]
},
{
"id" : "QuestionnaireResponse.subject",
"path" : "QuestionnaireResponse.subject",
"short" : "The subject of the questions",
"definition" : "The subject of the questionnaire response. This could be a patient, organization, practitioner, device, etc. This is who/what the answers apply to, but is not necessarily the source of information.",
"comment" : "If the Questionnaire declared a subjectType, the resource pointed to by this element must be an instance of one of the listed types.",
"requirements" : "Allows linking the answers to the individual the answers describe. May also affect access control.",
"alias" : ["Patient",
"Focus"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.subject"
},
{
"identity" : "w5",
"map" : "FiveWs.subject[x]"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=SBJ].role"
},
{
"identity" : "w5",
"map" : "FiveWs.subject"
}]
},
{
"id" : "QuestionnaireResponse.encounter",
"path" : "QuestionnaireResponse.encounter",
"short" : "Encounter created as part of",
"definition" : "The Encounter during which this questionnaire response was created or to which the creation of this record is tightly associated.",
"comment" : "This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter. A questionnaire that was initiated during an encounter but not fully completed during the encounter would still generally be associated with the encounter.",
"requirements" : "Provides context for the information that was captured. May also affect access control.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Encounter"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.encounter"
},
{
"identity" : "w5",
"map" : "FiveWs.context"
},
{
"identity" : "rim",
"map" : ".inboundRelationship(typeCode=COMP].source[classCode<=PCPR, moodCode=EVN]"
}]
},
{
"id" : "QuestionnaireResponse.authored",
"path" : "QuestionnaireResponse.authored",
"short" : "Date the answers were gathered",
"definition" : "The date and/or time that this set of answers were last changed.",
"comment" : "May be different from the lastUpdateTime of the resource itself, because that reflects when the data was known to the server, not when the data was captured.\n\nThis element is optional to allow for systems that might not know the value, however it SHOULD be populated if possible.",
"requirements" : "Clinicians need to be able to check the date that the information in the questionnaire was collected, to derive the context of the answers.",
"alias" : ["Date Created",
"Date published",
"Date Issued",
"Date updated"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "dateTime"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.occurrence[x]"
},
{
"identity" : "w5",
"map" : "FiveWs.recorded"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=AUT].time"
}]
},
{
"id" : "QuestionnaireResponse.author",
"path" : "QuestionnaireResponse.author",
"short" : "Person who received and recorded the answers",
"definition" : "Person who received the answers to the questions in the QuestionnaireResponse and recorded them in the system.",
"comment" : "Mapping a subject's answers to multiple choice options and determining what to put in the textual answer is a matter of interpretation. Authoring by device would indicate that some portion of the questionnaire had been auto-populated.",
"requirements" : "Need to know who interpreted the subject's answers to the questions in the questionnaire, and selected the appropriate options for answers.",
"alias" : ["Laboratory",
"Service",
"Practitioner",
"Department",
"Company",
"Performer"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Device",
"http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson",
"http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.performer"
},
{
"identity" : "w5",
"map" : "FiveWs.author"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=AUT].role"
}]
},
{
"id" : "QuestionnaireResponse.source",
"path" : "QuestionnaireResponse.source",
"short" : "The person who answered the questions",
"definition" : "The person who answered the questions about the subject.",
"comment" : "If not specified, no inference can be made about who provided the data.",
"requirements" : "When answering questions about a subject that is minor, incapable of answering or an animal, another human source may answer the questions.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.source"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=INF].role"
}]
},
{
"id" : "QuestionnaireResponse.item",
"path" : "QuestionnaireResponse.item",
"short" : "Groups and questions",
"definition" : "A group or question item from the original questionnaire for which answers are provided.",
"comment" : "Groups cannot have answers and therefore must nest directly within item. When dealing with questions, nesting must occur within each answer because some questions may have multiple answers (and the nesting occurs for each answer).",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "qrs-1",
"severity" : "error",
"human" : "Nested item can't be beneath both item and answer",
"expression" : "(answer.exists() and item.exists()).not()",
"xpath" : "not(exists(f:answer) and exists(f:item))"
}],
"mapping" : [{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=COMP].target[classCode=OBS, moodCode=EVN]"
}]
},
{
"id" : "QuestionnaireResponse.item.linkId",
"path" : "QuestionnaireResponse.item.linkId",
"short" : "Pointer to specific item from Questionnaire",
"definition" : "The item from the Questionnaire that corresponds to this item in the QuestionnaireResponse resource.",
"requirements" : "Items can repeat in the answers, so a direct 1..1 correspondence by position might not exist - requiring correspondence by identifier.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "string"
}],
"mapping" : [{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=DEFN].target[classCode=OBS, moodCode=DEFN].id"
}]
},
{
"id" : "QuestionnaireResponse.item.definition",
"path" : "QuestionnaireResponse.item.definition",
"short" : "ElementDefinition - details for the item",
"definition" : "A reference to an [ElementDefinition](elementdefinition.html) that provides the details for the item.",
"comment" : "The ElementDefinition must be in a [StructureDefinition](structuredefinition.html#), and must have a fragment identifier that identifies the specific data element by its id (Element.id). E.g. http://hl7.org/fhir/StructureDefinition/Observation#Observation.value[x].\n\nThere is no need for this element if the item pointed to by the linkId has a definition listed.",
"requirements" : "A common pattern is to define a set of data elements, and then build multiple different questionnaires for different circumstances to gather the data. This element provides traceability to the common definition.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "uri"
}],
"mapping" : [{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=DEFN].target[classCode=OBS, moodCode=DEFN].code"
}]
},
{
"id" : "QuestionnaireResponse.item.text",
"path" : "QuestionnaireResponse.item.text",
"short" : "Name for group or question text",
"definition" : "Text that is displayed above the contents of the group or as the text of the question being answered.",
"requirements" : "Allows the questionnaire response to be read without access to the questionnaire.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"mapping" : [{
"identity" : "rim",
"map" : ".text"
}]
},
{
"id" : "QuestionnaireResponse.item.answer",
"path" : "QuestionnaireResponse.item.answer",
"short" : "The response(s) to the question",
"definition" : "The respondent's answer(s) to the question.",
"comment" : "The value is nested because we cannot have a repeating structure that has variable type.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"mapping" : [{
"identity" : "rim",
"map" : ".value[type=LIST_ANY]"
}]
},
{
"id" : "QuestionnaireResponse.item.answer.value[x]",
"path" : "QuestionnaireResponse.item.answer.value[x]",
"short" : "Single-valued answer to the question",
"definition" : "The answer (or one of the answers) provided by the respondent to the question.",
"comment" : "More complex structures (Attachment, Resource and Quantity) will typically be limited to electronic forms that can expose an appropriate user interface to capture the components and enforce the constraints of a complex data type. Additional complex types can be introduced through extensions. Must match the datatype specified by Questionnaire.item.type in the corresponding Questionnaire.",
"requirements" : "Ability to retain a single-valued answer to a question.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "boolean"
},
{
"code" : "decimal"
},
{
"code" : "integer"
},
{
"code" : "date"
},
{
"code" : "dateTime"
},
{
"code" : "time"
},
{
"code" : "string"
},
{
"code" : "uri"
},
{
"code" : "Attachment"
},
{
"code" : "Coding"
},
{
"code" : "Quantity"
},
{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "QuestionnaireAnswer"
}],
"strength" : "example",
"description" : "Code indicating the response provided for a question.",
"valueSet" : "http://hl7.org/fhir/ValueSet/questionnaire-answers"
},
"mapping" : [{
"identity" : "rim",
"map" : ".item"
}]
},
{
"id" : "QuestionnaireResponse.item.answer.item",
"path" : "QuestionnaireResponse.item.answer.item",
"short" : "Nested groups and questions",
"definition" : "Nested groups and/or questions found within this particular answer.",
"requirements" : "It is useful to have \"sub-questions\", questions which normally appear when certain answers are given and which collect additional details.",
"min" : 0,
"max" : "*",
"contentReference" : "#QuestionnaireResponse.item",
"mapping" : [{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=COMP].target[classCode=OBS, moodCode=EVN]"
}]
},
{
"id" : "QuestionnaireResponse.item.item",
"path" : "QuestionnaireResponse.item.item",
"short" : "Nested questionnaire response items",
"definition" : "Questions or sub-groups nested beneath a question or group.",
"requirements" : "Reports can consist of complex nested groups.",
"min" : 0,
"max" : "*",
"contentReference" : "#QuestionnaireResponse.item",
"mapping" : [{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=COMP].target[classCode=OBS, moodCode=EVN]"
}]
}]
}
}
},
{
"fullUrl" : "http://hl7.org/fhir/StructureDefinition/RelatedPerson",
"resource" : {
"resourceType" : "StructureDefinition",
"id" : "RelatedPerson",
"meta" : {
"lastUpdated" : "2019-11-01T09:29:23.356+11:00"
},
"text" : {
"status" : "generated",
"div" : "Name Flags Card. Type Description & Constraints RelatedPerson 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 identifier Σ 0..* Identifier A human identifier for this person
active ?!Σ 0..1 boolean Whether this related person's record is in active use patient Σ 1..1 Reference(Patient) The patient this person is related to relationship Σ 0..* CodeableConcept The nature of the relationship
Patient relationship type (Preferred)
name Σ 0..* HumanName A name associated with the person
telecom Σ 0..* ContactPoint A contact detail for the person
gender Σ 0..1 code male | female | other | unknown
AdministrativeGender (Required) birthDate Σ 0..1 date The date on which the related person was born address Σ 0..* Address Address where the related person can be contacted or visited
photo 0..* Attachment Image of the person
period 0..1 Period Period of time that this relationship is considered valid communication 0..* BackboneElement A language which may be used to communicate with about the patient's health
language 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Common Languages (Preferred but limited to AllLanguages) preferred 0..1 boolean Language preference indicator
Documentation for this format
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Base.Individuals"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 2
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "patient"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "pa"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/RelatedPerson",
"version" : "4.0.1",
"name" : "RelatedPerson",
"status" : "draft",
"date" : "2019-11-01T09:29:23+11:00",
"publisher" : "Health Level Seven International (Patient Administration)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/pafm/index.cfm"
}]
}],
"description" : "Information about a person that is involved in the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care process.",
"purpose" : "Need to track persons related to the patient or the healthcare process.",
"fhirVersion" : "4.0.1",
"mapping" : [{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/fivews",
"name" : "FiveWs Pattern Mapping"
},
{
"identity" : "v2",
"uri" : "http://hl7.org/v2",
"name" : "HL7 v2 Mapping"
}],
"kind" : "resource",
"abstract" : false,
"type" : "RelatedPerson",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "RelatedPerson",
"path" : "RelatedPerson",
"short" : "A person that is related to a patient, but who is not a direct target of care",
"definition" : "Information about a person that is involved in the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care process.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "RelatedPerson",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "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",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.`div`.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "rim",
"map" : "role"
}]
},
{
"id" : "RelatedPerson.id",
"path" : "RelatedPerson.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "RelatedPerson.meta",
"path" : "RelatedPerson.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "RelatedPerson.implicitRules",
"path" : "RelatedPerson.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "RelatedPerson.language",
"path" : "RelatedPerson.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "RelatedPerson.text",
"path" : "RelatedPerson.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "RelatedPerson.contained",
"path" : "RelatedPerson.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "RelatedPerson.extension",
"path" : "RelatedPerson.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "RelatedPerson.modifierExtension",
"path" : "RelatedPerson.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "RelatedPerson.identifier",
"path" : "RelatedPerson.identifier",
"short" : "A human identifier for this person",
"definition" : "Identifier for a person within a particular scope.",
"requirements" : "People are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the patient. Examples are national person identifier and local identifier.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "RelatedPerson.identifier",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Identifier"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "v2",
"map" : "NK1-33"
},
{
"identity" : "rim",
"map" : ".id"
}]
},
{
"id" : "RelatedPerson.active",
"path" : "RelatedPerson.active",
"short" : "Whether this related person's record is in active use",
"definition" : "Whether this related person record is in active use.",
"comment" : "This element is labeled as a modifier because it may be used to mark that the resource was created in error.",
"requirements" : "Need to be able to mark a related person record as not to be used, such as if it was created in error.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "RelatedPerson.active",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"meaningWhenMissing" : "This resource is generally assumed to be active if no value is provided for the active element",
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid",
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.status"
},
{
"identity" : "rim",
"map" : ".statusCode"
}]
},
{
"id" : "RelatedPerson.patient",
"path" : "RelatedPerson.patient",
"short" : "The patient this person is related to",
"definition" : "The patient this person is related to.",
"requirements" : "We need to know which patient this RelatedPerson is related to.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "RelatedPerson.patient",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "v2",
"map" : "PID-3"
},
{
"identity" : "rim",
"map" : "scoper[classCode=PSN|ANM and determinerCode='INSTANCE']/playedRole[classCode='PAT']/id"
}]
},
{
"id" : "RelatedPerson.relationship",
"path" : "RelatedPerson.relationship",
"short" : "The nature of the relationship",
"definition" : "The nature of the relationship between a patient and the related person.",
"requirements" : "We need to know the relationship with the patient since it influences the interpretation of the information attributed to this person.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "RelatedPerson.relationship",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "PatientRelationshipType"
}],
"strength" : "preferred",
"description" : "The nature of the relationship between a patient and the related person.",
"valueSet" : "http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.class"
},
{
"identity" : "v2",
"map" : "NK1-3"
},
{
"identity" : "rim",
"map" : "code"
}]
},
{
"id" : "RelatedPerson.name",
"path" : "RelatedPerson.name",
"short" : "A name associated with the person",
"definition" : "A name associated with the person.",
"requirements" : "Related persons need to be identified by name, but it is uncommon to need details about multiple other names for that person.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "RelatedPerson.name",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "HumanName"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "v2",
"map" : "NK1-2"
},
{
"identity" : "rim",
"map" : "name"
}]
},
{
"id" : "RelatedPerson.telecom",
"path" : "RelatedPerson.telecom",
"short" : "A contact detail for the person",
"definition" : "A contact detail for the person, e.g. a telephone number or an email address.",
"comment" : "Person may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently, and also to help with identification.",
"requirements" : "People have (primary) ways to contact them in some way such as phone, email.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "RelatedPerson.telecom",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "ContactPoint"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "v2",
"map" : "NK1-5 / NK1-6 / NK1-40"
},
{
"identity" : "rim",
"map" : "telecom"
}]
},
{
"id" : "RelatedPerson.gender",
"path" : "RelatedPerson.gender",
"short" : "male | female | other | unknown",
"definition" : "Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.",
"requirements" : "Needed for identification of the person, in combination with (at least) name and birth date.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "RelatedPerson.gender",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AdministrativeGender"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "The gender of a person used for administrative purposes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1"
},
"mapping" : [{
"identity" : "v2",
"map" : "NK1-15"
},
{
"identity" : "rim",
"map" : "administrativeGender"
}]
},
{
"id" : "RelatedPerson.birthDate",
"path" : "RelatedPerson.birthDate",
"short" : "The date on which the related person was born",
"definition" : "The date on which the related person was born.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "RelatedPerson.birthDate",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "date"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "player.birthTime"
}]
},
{
"id" : "RelatedPerson.address",
"path" : "RelatedPerson.address",
"short" : "Address where the related person can be contacted or visited",
"definition" : "Address where the related person can be contacted or visited.",
"requirements" : "Need to keep track where the related person can be contacted per postal mail or visited.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "RelatedPerson.address",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Address"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "v2",
"map" : "NK1-4"
},
{
"identity" : "rim",
"map" : "addr"
}]
},
{
"id" : "RelatedPerson.photo",
"path" : "RelatedPerson.photo",
"short" : "Image of the person",
"definition" : "Image of the person.",
"requirements" : "Many EHR systems have the capability to capture an image of persons. Fits with newer social media usage too.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "RelatedPerson.photo",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Attachment"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "OBX-5 - needs a profile"
},
{
"identity" : "rim",
"map" : "player[classCode='PSN' and determinerCode='INSTANCE']/desc"
}]
},
{
"id" : "RelatedPerson.period",
"path" : "RelatedPerson.period",
"short" : "Period of time that this relationship is considered valid",
"definition" : "The period of time during which this relationship is or was active. If there are no dates defined, then the interval is unknown.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "RelatedPerson.period",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Period"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.done[x]"
},
{
"identity" : "rim",
"map" : ".effectiveTime"
}]
},
{
"id" : "RelatedPerson.communication",
"path" : "RelatedPerson.communication",
"short" : "A language which may be used to communicate with about the patient's health",
"definition" : "A language which may be used to communicate with about the patient's health.",
"comment" : "If no language is specified, this *implies* that the default local language is spoken. If you need to convey proficiency for multiple modes, then you need multiple RelatedPerson.Communication associations. If the RelatedPerson does not speak the default local language, then the Interpreter Required Standard can be used to explicitly declare that an interpreter is required.",
"requirements" : "If a related person does not speak the local language, interpreters may be required, so languages spoken and proficiency is an important things to keep track of both for patient and other persons of interest.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "RelatedPerson.communication",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "LanguageCommunication"
}]
},
{
"id" : "RelatedPerson.communication.id",
"path" : "RelatedPerson.communication.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "RelatedPerson.communication.extension",
"path" : "RelatedPerson.communication.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "RelatedPerson.communication.modifierExtension",
"path" : "RelatedPerson.communication.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "RelatedPerson.communication.language",
"path" : "RelatedPerson.communication.language",
"short" : "The language which can be used to communicate with the patient about his or her health",
"definition" : "The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. \"en\" for English, or \"en-US\" for American English versus \"en-EN\" for England English.",
"comment" : "The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems actually code this but instead have it as free text. Hence CodeableConcept instead of code as the data type.",
"requirements" : "Most systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "RelatedPerson.communication.language",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
},
"mapping" : [{
"identity" : "rim",
"map" : "player[classCode=PSN|ANM and determinerCode=INSTANCE]/languageCommunication/code"
}]
},
{
"id" : "RelatedPerson.communication.preferred",
"path" : "RelatedPerson.communication.preferred",
"short" : "Language preference indicator",
"definition" : "Indicates whether or not the patient prefers this language (over other languages he masters up a certain level).",
"comment" : "This language is specifically identified for communicating healthcare information.",
"requirements" : "People that master multiple languages up to certain level may prefer one or more, i.e. feel more confident in communicating in a particular language making other languages sort of a fall back method.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "RelatedPerson.communication.preferred",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "preferenceInd"
}]
}]
},
"differential" : {
"element" : [{
"id" : "RelatedPerson",
"path" : "RelatedPerson",
"short" : "A person that is related to a patient, but who is not a direct target of care",
"definition" : "Information about a person that is involved in the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care process.",
"min" : 0,
"max" : "*",
"mapping" : [{
"identity" : "rim",
"map" : "role"
}]
},
{
"id" : "RelatedPerson.identifier",
"path" : "RelatedPerson.identifier",
"short" : "A human identifier for this person",
"definition" : "Identifier for a person within a particular scope.",
"requirements" : "People are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the patient. Examples are national person identifier and local identifier.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Identifier"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "v2",
"map" : "NK1-33"
},
{
"identity" : "rim",
"map" : ".id"
}]
},
{
"id" : "RelatedPerson.active",
"path" : "RelatedPerson.active",
"short" : "Whether this related person's record is in active use",
"definition" : "Whether this related person record is in active use.",
"comment" : "This element is labeled as a modifier because it may be used to mark that the resource was created in error.",
"requirements" : "Need to be able to mark a related person record as not to be used, such as if it was created in error.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "boolean"
}],
"meaningWhenMissing" : "This resource is generally assumed to be active if no value is provided for the active element",
"isModifier" : true,
"isModifierReason" : "This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid",
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.status"
},
{
"identity" : "rim",
"map" : ".statusCode"
}]
},
{
"id" : "RelatedPerson.patient",
"path" : "RelatedPerson.patient",
"short" : "The patient this person is related to",
"definition" : "The patient this person is related to.",
"requirements" : "We need to know which patient this RelatedPerson is related to.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "v2",
"map" : "PID-3"
},
{
"identity" : "rim",
"map" : "scoper[classCode=PSN|ANM and determinerCode='INSTANCE']/playedRole[classCode='PAT']/id"
}]
},
{
"id" : "RelatedPerson.relationship",
"path" : "RelatedPerson.relationship",
"short" : "The nature of the relationship",
"definition" : "The nature of the relationship between a patient and the related person.",
"requirements" : "We need to know the relationship with the patient since it influences the interpretation of the information attributed to this person.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "PatientRelationshipType"
}],
"strength" : "preferred",
"description" : "The nature of the relationship between a patient and the related person.",
"valueSet" : "http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.class"
},
{
"identity" : "v2",
"map" : "NK1-3"
},
{
"identity" : "rim",
"map" : "code"
}]
},
{
"id" : "RelatedPerson.name",
"path" : "RelatedPerson.name",
"short" : "A name associated with the person",
"definition" : "A name associated with the person.",
"requirements" : "Related persons need to be identified by name, but it is uncommon to need details about multiple other names for that person.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "HumanName"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "v2",
"map" : "NK1-2"
},
{
"identity" : "rim",
"map" : "name"
}]
},
{
"id" : "RelatedPerson.telecom",
"path" : "RelatedPerson.telecom",
"short" : "A contact detail for the person",
"definition" : "A contact detail for the person, e.g. a telephone number or an email address.",
"comment" : "Person may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently, and also to help with identification.",
"requirements" : "People have (primary) ways to contact them in some way such as phone, email.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "ContactPoint"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "v2",
"map" : "NK1-5 / NK1-6 / NK1-40"
},
{
"identity" : "rim",
"map" : "telecom"
}]
},
{
"id" : "RelatedPerson.gender",
"path" : "RelatedPerson.gender",
"short" : "male | female | other | unknown",
"definition" : "Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.",
"requirements" : "Needed for identification of the person, in combination with (at least) name and birth date.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AdministrativeGender"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "The gender of a person used for administrative purposes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1"
},
"mapping" : [{
"identity" : "v2",
"map" : "NK1-15"
},
{
"identity" : "rim",
"map" : "administrativeGender"
}]
},
{
"id" : "RelatedPerson.birthDate",
"path" : "RelatedPerson.birthDate",
"short" : "The date on which the related person was born",
"definition" : "The date on which the related person was born.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "date"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "player.birthTime"
}]
},
{
"id" : "RelatedPerson.address",
"path" : "RelatedPerson.address",
"short" : "Address where the related person can be contacted or visited",
"definition" : "Address where the related person can be contacted or visited.",
"requirements" : "Need to keep track where the related person can be contacted per postal mail or visited.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Address"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "v2",
"map" : "NK1-4"
},
{
"identity" : "rim",
"map" : "addr"
}]
},
{
"id" : "RelatedPerson.photo",
"path" : "RelatedPerson.photo",
"short" : "Image of the person",
"definition" : "Image of the person.",
"requirements" : "Many EHR systems have the capability to capture an image of persons. Fits with newer social media usage too.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Attachment"
}],
"mapping" : [{
"identity" : "v2",
"map" : "OBX-5 - needs a profile"
},
{
"identity" : "rim",
"map" : "player[classCode='PSN' and determinerCode='INSTANCE']/desc"
}]
},
{
"id" : "RelatedPerson.period",
"path" : "RelatedPerson.period",
"short" : "Period of time that this relationship is considered valid",
"definition" : "The period of time during which this relationship is or was active. If there are no dates defined, then the interval is unknown.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Period"
}],
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.done[x]"
},
{
"identity" : "rim",
"map" : ".effectiveTime"
}]
},
{
"id" : "RelatedPerson.communication",
"path" : "RelatedPerson.communication",
"short" : "A language which may be used to communicate with about the patient's health",
"definition" : "A language which may be used to communicate with about the patient's health.",
"comment" : "If no language is specified, this *implies* that the default local language is spoken. If you need to convey proficiency for multiple modes, then you need multiple RelatedPerson.Communication associations. If the RelatedPerson does not speak the default local language, then the Interpreter Required Standard can be used to explicitly declare that an interpreter is required.",
"requirements" : "If a related person does not speak the local language, interpreters may be required, so languages spoken and proficiency is an important things to keep track of both for patient and other persons of interest.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"mapping" : [{
"identity" : "rim",
"map" : "LanguageCommunication"
}]
},
{
"id" : "RelatedPerson.communication.language",
"path" : "RelatedPerson.communication.language",
"short" : "The language which can be used to communicate with the patient about his or her health",
"definition" : "The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. \"en\" for English, or \"en-US\" for American English versus \"en-EN\" for England English.",
"comment" : "The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems actually code this but instead have it as free text. Hence CodeableConcept instead of code as the data type.",
"requirements" : "Most systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
},
"mapping" : [{
"identity" : "rim",
"map" : "player[classCode=PSN|ANM and determinerCode=INSTANCE]/languageCommunication/code"
}]
},
{
"id" : "RelatedPerson.communication.preferred",
"path" : "RelatedPerson.communication.preferred",
"short" : "Language preference indicator",
"definition" : "Indicates whether or not the patient prefers this language (over other languages he masters up a certain level).",
"comment" : "This language is specifically identified for communicating healthcare information.",
"requirements" : "People that master multiple languages up to certain level may prefer one or more, i.e. feel more confident in communicating in a particular language making other languages sort of a fall back method.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "boolean"
}],
"mapping" : [{
"identity" : "rim",
"map" : "preferenceInd"
}]
}]
}
}
},
{
"fullUrl" : "http://hl7.org/fhir/StructureDefinition/RequestGroup",
"resource" : {
"resourceType" : "StructureDefinition",
"id" : "RequestGroup",
"meta" : {
"lastUpdated" : "2019-11-01T09:29:23.356+11:00"
},
"text" : {
"status" : "generated",
"div" : "Name Flags Card. Type Description & Constraints RequestGroup TU DomainResource A group of related requests
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension identifier Σ 0..* Identifier Business identifier
instantiatesCanonical Σ 0..* canonical() Instantiates FHIR protocol or definition
instantiatesUri Σ 0..* uri Instantiates external protocol or definition
basedOn 0..* Reference(Any) Fulfills plan, proposal, or order
replaces 0..* Reference(Any) Request(s) replaced by this request
groupIdentifier Σ 0..1 Identifier Composite request this is part of status ?!Σ 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
RequestStatus (Required) intent ?!Σ 1..1 code proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
RequestIntent (Required) priority Σ 0..1 code routine | urgent | asap | stat
Request priority (Required) code Σ 0..1 CodeableConcept What's being requested/ordered subject 0..1 Reference(Patient | Group) Who the request group is about encounter 0..1 Reference(Encounter) Created as part of authoredOn 0..1 dateTime When the request group was authored author 0..1 Reference(Device | Practitioner | PractitionerRole) Device or practitioner that authored the request group reasonCode 0..* CodeableConcept Why the request group is needed
reasonReference 0..* Reference(Condition | Observation | DiagnosticReport | DocumentReference) Why the request group is needed
note 0..* Annotation Additional notes about the response
action I 0..* BackboneElement Proposed actions, if any
+ Rule: Must have resource or action but not both
prefix 0..1 string User-visible prefix for the action (e.g. 1. or A.) title 0..1 string User-visible title description Σ 0..1 string Short description of the action textEquivalent Σ 0..1 string Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system priority 0..1 code routine | urgent | asap | stat
Request priority (Required) code 0..* CodeableConcept Code representing the meaning of the action or sub-actions
documentation 0..* RelatedArtifact Supporting documentation for the intended performer of the action
condition 0..* BackboneElement Whether or not the action is applicable
kind 1..1 code applicability | start | stop
ActionConditionKind (Required) expression 0..1 Expression Boolean-valued expression relatedAction 0..* BackboneElement Relationship to another action
actionId 1..1 id What action this is related to relationship 1..1 code before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
ActionRelationshipType (Required) offset[x] 0..1 Time offset for the relationship offsetDuration Duration offsetRange Range timing[x] 0..1 When the action should take place timingDateTime dateTime timingAge Age timingPeriod Period timingDuration Duration timingRange Range timingTiming Timing participant 0..* Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device) Who should perform the action
type 0..1 CodeableConcept create | update | remove | fire-event
ActionType (Extensible) groupingBehavior 0..1 code visual-group | logical-group | sentence-group
ActionGroupingBehavior (Required) selectionBehavior 0..1 code any | all | all-or-none | exactly-one | at-most-one | one-or-more
ActionSelectionBehavior (Required) requiredBehavior 0..1 code must | could | must-unless-documented
ActionRequiredBehavior (Required) precheckBehavior 0..1 code yes | no
ActionPrecheckBehavior (Required) cardinalityBehavior 0..1 code single | multiple
ActionCardinalityBehavior (Required) resource I 0..1 Reference(Any) The target of the action action I 0..* see action Sub action
Documentation for this format
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Clinical.Care Provision"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 2
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "business"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "cds"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/RequestGroup",
"version" : "4.0.1",
"name" : "RequestGroup",
"status" : "draft",
"date" : "2019-11-01T09:29:23+11:00",
"publisher" : "Health Level Seven International (Clinical Decision Support)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/dss/index.cfm"
}]
}],
"description" : "A group of related requests that can be used to capture intended activities that have inter-dependencies such as \"give this medication after that one\".",
"fhirVersion" : "4.0.1",
"mapping" : [{
"identity" : "workflow",
"uri" : "http://hl7.org/fhir/workflow",
"name" : "Workflow Pattern"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/fivews",
"name" : "FiveWs Pattern Mapping"
},
{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
}],
"kind" : "resource",
"abstract" : false,
"type" : "RequestGroup",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "RequestGroup",
"path" : "RequestGroup",
"short" : "A group of related requests",
"definition" : "A group of related requests that can be used to capture intended activities that have inter-dependencies such as \"give this medication after that one\".",
"min" : 0,
"max" : "*",
"base" : {
"path" : "RequestGroup",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "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",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.`div`.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "workflow",
"map" : "Request"
}]
},
{
"id" : "RequestGroup.id",
"path" : "RequestGroup.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "RequestGroup.meta",
"path" : "RequestGroup.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "RequestGroup.implicitRules",
"path" : "RequestGroup.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "RequestGroup.language",
"path" : "RequestGroup.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "RequestGroup.text",
"path" : "RequestGroup.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "RequestGroup.contained",
"path" : "RequestGroup.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "RequestGroup.extension",
"path" : "RequestGroup.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "RequestGroup.modifierExtension",
"path" : "RequestGroup.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "RequestGroup.identifier",
"path" : "RequestGroup.identifier",
"short" : "Business identifier",
"definition" : "Allows a service to provide a unique, business identifier for the request.",
"requirements" : "Allows identification of the request as it is known by various participating systems and in a way that remains consistent across servers.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "RequestGroup.identifier",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Identifier"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.identifier"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
}]
},
{
"id" : "RequestGroup.instantiatesCanonical",
"path" : "RequestGroup.instantiatesCanonical",
"short" : "Instantiates FHIR protocol or definition",
"definition" : "A canonical URL referencing a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "RequestGroup.instantiatesCanonical",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "canonical"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.instantiatesCanonical"
}]
},
{
"id" : "RequestGroup.instantiatesUri",
"path" : "RequestGroup.instantiatesUri",
"short" : "Instantiates external protocol or definition",
"definition" : "A URL referencing an externally defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "RequestGroup.instantiatesUri",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.instantiatesUri"
}]
},
{
"id" : "RequestGroup.basedOn",
"path" : "RequestGroup.basedOn",
"short" : "Fulfills plan, proposal, or order",
"definition" : "A plan, proposal or order that is fulfilled in whole or in part by this request.",
"requirements" : "Allows tracing of authorization for the request and tracking whether proposals/recommendations were acted upon.",
"alias" : ["fulfills"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "RequestGroup.basedOn",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.basedOn"
}]
},
{
"id" : "RequestGroup.replaces",
"path" : "RequestGroup.replaces",
"short" : "Request(s) replaced by this request",
"definition" : "Completed or terminated request(s) whose function is taken by this new request.",
"comment" : "The replacement could be because the initial request was immediately rejected (due to an issue) or because the previous request was completed, but the need for the action described by the request remains ongoing.",
"requirements" : "Allows tracing the continuation of a therapy or administrative process instantiated through multiple requests.",
"alias" : ["supersedes",
"prior",
"renewed order"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "RequestGroup.replaces",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.replaces"
}]
},
{
"id" : "RequestGroup.groupIdentifier",
"path" : "RequestGroup.groupIdentifier",
"short" : "Composite request this is part of",
"definition" : "A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition, prescription or similar form.",
"comment" : "Requests are linked either by a \"basedOn\" relationship (i.e. one request is fulfilling another) or by having a common requisition. Requests that are part of the same requisition are generally treated independently from the perspective of changing their state or maintaining them after initial creation.",
"requirements" : "Some business processes need to know if multiple items were ordered as part of the same \"prescription\" or \"requisition\" for billing or other purposes.",
"alias" : ["grouperid",
"requisition"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "RequestGroup.groupIdentifier",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Identifier"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.groupIdentifier"
}]
},
{
"id" : "RequestGroup.status",
"path" : "RequestGroup.status",
"short" : "draft | active | on-hold | revoked | completed | entered-in-error | unknown",
"definition" : "The current state of the request. For request groups, the status reflects the status of all the requests in the group.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "RequestGroup.status",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "RequestStatus"
}],
"strength" : "required",
"description" : "Codes identifying the lifecycle stage of a request.",
"valueSet" : "http://hl7.org/fhir/ValueSet/request-status|4.0.1"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.status"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
}]
},
{
"id" : "RequestGroup.intent",
"path" : "RequestGroup.intent",
"short" : "proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option",
"definition" : "Indicates the level of authority/intentionality associated with the request and where the request fits into the workflow chain.",
"requirements" : "Proposals/recommendations, plans and orders all use the same structure and can exist in the same fulfillment chain.",
"alias" : ["category"],
"min" : 1,
"max" : "1",
"base" : {
"path" : "RequestGroup.intent",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element changes the interpretation of all descriptive attributes. For example \"the time the request is recommended to occur\" vs. \"the time the request is authorized to occur\" or \"who is recommended to perform the request\" vs. \"who is authorized to perform the request",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "RequestIntent"
}],
"strength" : "required",
"description" : "Codes indicating the degree of authority/intentionality associated with a request.",
"valueSet" : "http://hl7.org/fhir/ValueSet/request-intent|4.0.1"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.intent"
},
{
"identity" : "w5",
"map" : "FiveWs.class"
}]
},
{
"id" : "RequestGroup.priority",
"path" : "RequestGroup.priority",
"short" : "routine | urgent | asap | stat",
"definition" : "Indicates how quickly the request should be addressed with respect to other requests.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "RequestGroup.priority",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"meaningWhenMissing" : "If missing, this request should be performed with normal priority",
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "RequestPriority"
}],
"strength" : "required",
"description" : "Identifies the level of importance to be assigned to actioning the request.",
"valueSet" : "http://hl7.org/fhir/ValueSet/request-priority|4.0.1"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.priority"
},
{
"identity" : "w5",
"map" : "FiveWs.grade"
}]
},
{
"id" : "RequestGroup.code",
"path" : "RequestGroup.code",
"short" : "What's being requested/ordered",
"definition" : "A code that identifies what the overall request group is.",
"comment" : "This element can be used to provide a code that captures the meaning of the request group as a whole, as opposed to the code of the action element, which captures the meaning of the individual actions within the request group.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "RequestGroup.code",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.code"
},
{
"identity" : "w5",
"map" : "FiveWs.what[x]"
}]
},
{
"id" : "RequestGroup.subject",
"path" : "RequestGroup.subject",
"short" : "Who the request group is about",
"definition" : "The subject for which the request group was created.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "RequestGroup.subject",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Group"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.subject"
},
{
"identity" : "w5",
"map" : "FiveWs.subject[x]"
},
{
"identity" : "w5",
"map" : "FiveWs.subject"
}]
},
{
"id" : "RequestGroup.encounter",
"path" : "RequestGroup.encounter",
"short" : "Created as part of",
"definition" : "Describes the context of the request group, if any.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "RequestGroup.encounter",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Encounter"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.encounter"
},
{
"identity" : "w5",
"map" : "FiveWs.context"
}]
},
{
"id" : "RequestGroup.authoredOn",
"path" : "RequestGroup.authoredOn",
"short" : "When the request group was authored",
"definition" : "Indicates when the request group was created.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "RequestGroup.authoredOn",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.authoredOn"
},
{
"identity" : "w5",
"map" : "FiveWs.recorded"
}]
},
{
"id" : "RequestGroup.author",
"path" : "RequestGroup.author",
"short" : "Device or practitioner that authored the request group",
"definition" : "Provides a reference to the author of the request group.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "RequestGroup.author",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Device",
"http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.requester"
},
{
"identity" : "w5",
"map" : "FiveWs.author"
}]
},
{
"id" : "RequestGroup.reasonCode",
"path" : "RequestGroup.reasonCode",
"short" : "Why the request group is needed",
"definition" : "Describes the reason for the request group in coded or textual form.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "RequestGroup.reasonCode",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.reasonCode"
},
{
"identity" : "w5",
"map" : "FiveWs.why[x]"
}]
},
{
"id" : "RequestGroup.reasonReference",
"path" : "RequestGroup.reasonReference",
"short" : "Why the request group is needed",
"definition" : "Indicates another resource whose existence justifies this request group.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "RequestGroup.reasonReference",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Condition",
"http://hl7.org/fhir/StructureDefinition/Observation",
"http://hl7.org/fhir/StructureDefinition/DiagnosticReport",
"http://hl7.org/fhir/StructureDefinition/DocumentReference"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.reasonReference"
},
{
"identity" : "w5",
"map" : "FiveWs.why[x]"
}]
},
{
"id" : "RequestGroup.note",
"path" : "RequestGroup.note",
"short" : "Additional notes about the response",
"definition" : "Provides a mechanism to communicate additional information about the response.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "RequestGroup.note",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Annotation"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.note"
}]
},
{
"id" : "RequestGroup.action",
"path" : "RequestGroup.action",
"short" : "Proposed actions, if any",
"definition" : "The actions, if any, produced by the evaluation of the artifact.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "RequestGroup.action",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "rqg-1",
"severity" : "error",
"human" : "Must have resource or action but not both",
"expression" : "resource.exists() != action.exists()",
"xpath" : "exists(f:resource) != exists(f:action)"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "RequestGroup.action.id",
"path" : "RequestGroup.action.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "RequestGroup.action.extension",
"path" : "RequestGroup.action.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "RequestGroup.action.modifierExtension",
"path" : "RequestGroup.action.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "RequestGroup.action.prefix",
"path" : "RequestGroup.action.prefix",
"short" : "User-visible prefix for the action (e.g. 1. or A.)",
"definition" : "A user-visible prefix for the action.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "RequestGroup.action.prefix",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "RequestGroup.action.title",
"path" : "RequestGroup.action.title",
"short" : "User-visible title",
"definition" : "The title of the action displayed to a user.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "RequestGroup.action.title",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "RequestGroup.action.description",
"path" : "RequestGroup.action.description",
"short" : "Short description of the action",
"definition" : "A short description of the action used to provide a summary to display to the user.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "RequestGroup.action.description",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "RequestGroup.action.textEquivalent",
"path" : "RequestGroup.action.textEquivalent",
"short" : "Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system",
"definition" : "A text equivalent of the action to be performed. This provides a human-interpretable description of the action when the definition is consumed by a system that might not be capable of interpreting it dynamically.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "RequestGroup.action.textEquivalent",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "RequestGroup.action.priority",
"path" : "RequestGroup.action.priority",
"short" : "routine | urgent | asap | stat",
"definition" : "Indicates how quickly the action should be addressed with respect to other actions.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "RequestGroup.action.priority",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "RequestPriority"
}],
"strength" : "required",
"description" : "Identifies the level of importance to be assigned to actioning the request.",
"valueSet" : "http://hl7.org/fhir/ValueSet/request-priority|4.0.1"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.priority"
}]
},
{
"id" : "RequestGroup.action.code",
"path" : "RequestGroup.action.code",
"short" : "Code representing the meaning of the action or sub-actions",
"definition" : "A code that provides meaning for the action or action group. For example, a section may have a LOINC code for a section of a documentation template.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "RequestGroup.action.code",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.code"
}]
},
{
"id" : "RequestGroup.action.documentation",
"path" : "RequestGroup.action.documentation",
"short" : "Supporting documentation for the intended performer of the action",
"definition" : "Didactic or other informational resources associated with the action that can be provided to the CDS recipient. Information resources can include inline text commentary and links to web resources.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "RequestGroup.action.documentation",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "RelatedArtifact"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.supportingInfo"
}]
},
{
"id" : "RequestGroup.action.condition",
"path" : "RequestGroup.action.condition",
"short" : "Whether or not the action is applicable",
"definition" : "An expression that describes applicability criteria, or start/stop conditions for the action.",
"comment" : "When multiple conditions of the same kind are present, the effects are combined using AND semantics, so the overall condition is true only if all of the conditions are true.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "RequestGroup.action.condition",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "RequestGroup.action.condition.id",
"path" : "RequestGroup.action.condition.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "RequestGroup.action.condition.extension",
"path" : "RequestGroup.action.condition.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "RequestGroup.action.condition.modifierExtension",
"path" : "RequestGroup.action.condition.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "RequestGroup.action.condition.kind",
"path" : "RequestGroup.action.condition.kind",
"short" : "applicability | start | stop",
"definition" : "The kind of condition.",
"comment" : "Applicability criteria are used to determine immediate applicability when a plan definition is applied to a given context. Start and stop criteria are carried through application and used to describe enter/exit criteria for an action.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "RequestGroup.action.condition.kind",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ActionConditionKind"
}],
"strength" : "required",
"description" : "The kind of condition for the action.",
"valueSet" : "http://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1"
}
},
{
"id" : "RequestGroup.action.condition.expression",
"path" : "RequestGroup.action.condition.expression",
"short" : "Boolean-valued expression",
"definition" : "An expression that returns true or false, indicating whether or not the condition is satisfied.",
"comment" : "The expression may be inlined, or may be a reference to a named expression within a logic library referenced by the library element.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "RequestGroup.action.condition.expression",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Expression"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "RequestGroup.action.relatedAction",
"path" : "RequestGroup.action.relatedAction",
"short" : "Relationship to another action",
"definition" : "A relationship to another action such as \"before\" or \"30-60 minutes after start of\".",
"min" : 0,
"max" : "*",
"base" : {
"path" : "RequestGroup.action.relatedAction",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "RequestGroup.action.relatedAction.id",
"path" : "RequestGroup.action.relatedAction.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "RequestGroup.action.relatedAction.extension",
"path" : "RequestGroup.action.relatedAction.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "RequestGroup.action.relatedAction.modifierExtension",
"path" : "RequestGroup.action.relatedAction.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "RequestGroup.action.relatedAction.actionId",
"path" : "RequestGroup.action.relatedAction.actionId",
"short" : "What action this is related to",
"definition" : "The element id of the action this is related to.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "RequestGroup.action.relatedAction.actionId",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "id"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "RequestGroup.action.relatedAction.relationship",
"path" : "RequestGroup.action.relatedAction.relationship",
"short" : "before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end",
"definition" : "The relationship of this action to the related action.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "RequestGroup.action.relatedAction.relationship",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ActionRelationshipType"
}],
"strength" : "required",
"description" : "Defines the types of relationships between actions.",
"valueSet" : "http://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1"
}
},
{
"id" : "RequestGroup.action.relatedAction.offset[x]",
"path" : "RequestGroup.action.relatedAction.offset[x]",
"short" : "Time offset for the relationship",
"definition" : "A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "RequestGroup.action.relatedAction.offset[x]",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Duration"
},
{
"code" : "Range"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "RequestGroup.action.timing[x]",
"path" : "RequestGroup.action.timing[x]",
"short" : "When the action should take place",
"definition" : "An optional value describing when the action should be performed.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "RequestGroup.action.timing[x]",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
},
{
"code" : "Age"
},
{
"code" : "Period"
},
{
"code" : "Duration"
},
{
"code" : "Range"
},
{
"code" : "Timing"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.occurrence[x]"
}]
},
{
"id" : "RequestGroup.action.participant",
"path" : "RequestGroup.action.participant",
"short" : "Who should perform the action",
"definition" : "The participant that should perform or be responsible for this action.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "RequestGroup.action.participant",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson",
"http://hl7.org/fhir/StructureDefinition/Device"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.performer"
},
{
"identity" : "w5",
"map" : "FiveWs.actor"
}]
},
{
"id" : "RequestGroup.action.type",
"path" : "RequestGroup.action.type",
"short" : "create | update | remove | fire-event",
"definition" : "The type of action to perform (create, update, remove).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "RequestGroup.action.type",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ActionType"
}],
"strength" : "extensible",
"description" : "The type of action to be performed.",
"valueSet" : "http://hl7.org/fhir/ValueSet/action-type"
}
},
{
"id" : "RequestGroup.action.groupingBehavior",
"path" : "RequestGroup.action.groupingBehavior",
"short" : "visual-group | logical-group | sentence-group",
"definition" : "Defines the grouping behavior for the action and its children.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "RequestGroup.action.groupingBehavior",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ActionGroupingBehavior"
}],
"strength" : "required",
"description" : "Defines organization behavior of a group.",
"valueSet" : "http://hl7.org/fhir/ValueSet/action-grouping-behavior|4.0.1"
}
},
{
"id" : "RequestGroup.action.selectionBehavior",
"path" : "RequestGroup.action.selectionBehavior",
"short" : "any | all | all-or-none | exactly-one | at-most-one | one-or-more",
"definition" : "Defines the selection behavior for the action and its children.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "RequestGroup.action.selectionBehavior",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ActionSelectionBehavior"
}],
"strength" : "required",
"description" : "Defines selection behavior of a group.",
"valueSet" : "http://hl7.org/fhir/ValueSet/action-selection-behavior|4.0.1"
}
},
{
"id" : "RequestGroup.action.requiredBehavior",
"path" : "RequestGroup.action.requiredBehavior",
"short" : "must | could | must-unless-documented",
"definition" : "Defines expectations around whether an action is required.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "RequestGroup.action.requiredBehavior",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ActionRequiredBehavior"
}],
"strength" : "required",
"description" : "Defines expectations around whether an action or action group is required.",
"valueSet" : "http://hl7.org/fhir/ValueSet/action-required-behavior|4.0.1"
}
},
{
"id" : "RequestGroup.action.precheckBehavior",
"path" : "RequestGroup.action.precheckBehavior",
"short" : "yes | no",
"definition" : "Defines whether the action should usually be preselected.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "RequestGroup.action.precheckBehavior",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ActionPrecheckBehavior"
}],
"strength" : "required",
"description" : "Defines selection frequency behavior for an action or group.",
"valueSet" : "http://hl7.org/fhir/ValueSet/action-precheck-behavior|4.0.1"
}
},
{
"id" : "RequestGroup.action.cardinalityBehavior",
"path" : "RequestGroup.action.cardinalityBehavior",
"short" : "single | multiple",
"definition" : "Defines whether the action can be selected multiple times.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "RequestGroup.action.cardinalityBehavior",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ActionCardinalityBehavior"
}],
"strength" : "required",
"description" : "Defines behavior for an action or a group for how many times that item may be repeated.",
"valueSet" : "http://hl7.org/fhir/ValueSet/action-cardinality-behavior|4.0.1"
}
},
{
"id" : "RequestGroup.action.resource",
"path" : "RequestGroup.action.resource",
"short" : "The target of the action",
"definition" : "The resource that is the target of the action (e.g. CommunicationRequest).",
"comment" : "The target resource SHALL be a [Request](request.html) resource with a Request.intent set to \"option\".",
"min" : 0,
"max" : "1",
"base" : {
"path" : "RequestGroup.action.resource",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"condition" : ["rqg-1"],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "RequestGroup.action.action",
"path" : "RequestGroup.action.action",
"short" : "Sub action",
"definition" : "Sub actions.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "RequestGroup.action.action",
"min" : 0,
"max" : "*"
},
"contentReference" : "#RequestGroup.action",
"condition" : ["rqg-1"],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
}]
},
"differential" : {
"element" : [{
"id" : "RequestGroup",
"path" : "RequestGroup",
"short" : "A group of related requests",
"definition" : "A group of related requests that can be used to capture intended activities that have inter-dependencies such as \"give this medication after that one\".",
"min" : 0,
"max" : "*",
"mapping" : [{
"identity" : "workflow",
"map" : "Request"
}]
},
{
"id" : "RequestGroup.identifier",
"path" : "RequestGroup.identifier",
"short" : "Business identifier",
"definition" : "Allows a service to provide a unique, business identifier for the request.",
"requirements" : "Allows identification of the request as it is known by various participating systems and in a way that remains consistent across servers.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Identifier"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.identifier"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
}]
},
{
"id" : "RequestGroup.instantiatesCanonical",
"path" : "RequestGroup.instantiatesCanonical",
"short" : "Instantiates FHIR protocol or definition",
"definition" : "A canonical URL referencing a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "canonical"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.instantiatesCanonical"
}]
},
{
"id" : "RequestGroup.instantiatesUri",
"path" : "RequestGroup.instantiatesUri",
"short" : "Instantiates external protocol or definition",
"definition" : "A URL referencing an externally defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "uri"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.instantiatesUri"
}]
},
{
"id" : "RequestGroup.basedOn",
"path" : "RequestGroup.basedOn",
"short" : "Fulfills plan, proposal, or order",
"definition" : "A plan, proposal or order that is fulfilled in whole or in part by this request.",
"requirements" : "Allows tracing of authorization for the request and tracking whether proposals/recommendations were acted upon.",
"alias" : ["fulfills"],
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Request.basedOn"
}]
},
{
"id" : "RequestGroup.replaces",
"path" : "RequestGroup.replaces",
"short" : "Request(s) replaced by this request",
"definition" : "Completed or terminated request(s) whose function is taken by this new request.",
"comment" : "The replacement could be because the initial request was immediately rejected (due to an issue) or because the previous request was completed, but the need for the action described by the request remains ongoing.",
"requirements" : "Allows tracing the continuation of a therapy or administrative process instantiated through multiple requests.",
"alias" : ["supersedes",
"prior",
"renewed order"],
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Request.replaces"
}]
},
{
"id" : "RequestGroup.groupIdentifier",
"path" : "RequestGroup.groupIdentifier",
"short" : "Composite request this is part of",
"definition" : "A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition, prescription or similar form.",
"comment" : "Requests are linked either by a \"basedOn\" relationship (i.e. one request is fulfilling another) or by having a common requisition. Requests that are part of the same requisition are generally treated independently from the perspective of changing their state or maintaining them after initial creation.",
"requirements" : "Some business processes need to know if multiple items were ordered as part of the same \"prescription\" or \"requisition\" for billing or other purposes.",
"alias" : ["grouperid",
"requisition"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Identifier"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.groupIdentifier"
}]
},
{
"id" : "RequestGroup.status",
"path" : "RequestGroup.status",
"short" : "draft | active | on-hold | revoked | completed | entered-in-error | unknown",
"definition" : "The current state of the request. For request groups, the status reflects the status of all the requests in the group.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "RequestStatus"
}],
"strength" : "required",
"description" : "Codes identifying the lifecycle stage of a request.",
"valueSet" : "http://hl7.org/fhir/ValueSet/request-status|4.0.1"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.status"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
}]
},
{
"id" : "RequestGroup.intent",
"path" : "RequestGroup.intent",
"short" : "proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option",
"definition" : "Indicates the level of authority/intentionality associated with the request and where the request fits into the workflow chain.",
"requirements" : "Proposals/recommendations, plans and orders all use the same structure and can exist in the same fulfillment chain.",
"alias" : ["category"],
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isModifier" : true,
"isModifierReason" : "This element changes the interpretation of all descriptive attributes. For example \"the time the request is recommended to occur\" vs. \"the time the request is authorized to occur\" or \"who is recommended to perform the request\" vs. \"who is authorized to perform the request",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "RequestIntent"
}],
"strength" : "required",
"description" : "Codes indicating the degree of authority/intentionality associated with a request.",
"valueSet" : "http://hl7.org/fhir/ValueSet/request-intent|4.0.1"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.intent"
},
{
"identity" : "w5",
"map" : "FiveWs.class"
}]
},
{
"id" : "RequestGroup.priority",
"path" : "RequestGroup.priority",
"short" : "routine | urgent | asap | stat",
"definition" : "Indicates how quickly the request should be addressed with respect to other requests.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "code"
}],
"meaningWhenMissing" : "If missing, this request should be performed with normal priority",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "RequestPriority"
}],
"strength" : "required",
"description" : "Identifies the level of importance to be assigned to actioning the request.",
"valueSet" : "http://hl7.org/fhir/ValueSet/request-priority|4.0.1"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.priority"
},
{
"identity" : "w5",
"map" : "FiveWs.grade"
}]
},
{
"id" : "RequestGroup.code",
"path" : "RequestGroup.code",
"short" : "What's being requested/ordered",
"definition" : "A code that identifies what the overall request group is.",
"comment" : "This element can be used to provide a code that captures the meaning of the request group as a whole, as opposed to the code of the action element, which captures the meaning of the individual actions within the request group.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.code"
},
{
"identity" : "w5",
"map" : "FiveWs.what[x]"
}]
},
{
"id" : "RequestGroup.subject",
"path" : "RequestGroup.subject",
"short" : "Who the request group is about",
"definition" : "The subject for which the request group was created.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Group"]
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Request.subject"
},
{
"identity" : "w5",
"map" : "FiveWs.subject[x]"
},
{
"identity" : "w5",
"map" : "FiveWs.subject"
}]
},
{
"id" : "RequestGroup.encounter",
"path" : "RequestGroup.encounter",
"short" : "Created as part of",
"definition" : "Describes the context of the request group, if any.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Encounter"]
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Request.encounter"
},
{
"identity" : "w5",
"map" : "FiveWs.context"
}]
},
{
"id" : "RequestGroup.authoredOn",
"path" : "RequestGroup.authoredOn",
"short" : "When the request group was authored",
"definition" : "Indicates when the request group was created.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "dateTime"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Request.authoredOn"
},
{
"identity" : "w5",
"map" : "FiveWs.recorded"
}]
},
{
"id" : "RequestGroup.author",
"path" : "RequestGroup.author",
"short" : "Device or practitioner that authored the request group",
"definition" : "Provides a reference to the author of the request group.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Device",
"http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole"]
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Request.requester"
},
{
"identity" : "w5",
"map" : "FiveWs.author"
}]
},
{
"id" : "RequestGroup.reasonCode",
"path" : "RequestGroup.reasonCode",
"short" : "Why the request group is needed",
"definition" : "Describes the reason for the request group in coded or textual form.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Request.reasonCode"
},
{
"identity" : "w5",
"map" : "FiveWs.why[x]"
}]
},
{
"id" : "RequestGroup.reasonReference",
"path" : "RequestGroup.reasonReference",
"short" : "Why the request group is needed",
"definition" : "Indicates another resource whose existence justifies this request group.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Condition",
"http://hl7.org/fhir/StructureDefinition/Observation",
"http://hl7.org/fhir/StructureDefinition/DiagnosticReport",
"http://hl7.org/fhir/StructureDefinition/DocumentReference"]
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Request.reasonReference"
},
{
"identity" : "w5",
"map" : "FiveWs.why[x]"
}]
},
{
"id" : "RequestGroup.note",
"path" : "RequestGroup.note",
"short" : "Additional notes about the response",
"definition" : "Provides a mechanism to communicate additional information about the response.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Annotation"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Request.note"
}]
},
{
"id" : "RequestGroup.action",
"path" : "RequestGroup.action",
"short" : "Proposed actions, if any",
"definition" : "The actions, if any, produced by the evaluation of the artifact.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "rqg-1",
"severity" : "error",
"human" : "Must have resource or action but not both",
"expression" : "resource.exists() != action.exists()",
"xpath" : "exists(f:resource) != exists(f:action)"
}]
},
{
"id" : "RequestGroup.action.prefix",
"path" : "RequestGroup.action.prefix",
"short" : "User-visible prefix for the action (e.g. 1. or A.)",
"definition" : "A user-visible prefix for the action.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}]
},
{
"id" : "RequestGroup.action.title",
"path" : "RequestGroup.action.title",
"short" : "User-visible title",
"definition" : "The title of the action displayed to a user.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}]
},
{
"id" : "RequestGroup.action.description",
"path" : "RequestGroup.action.description",
"short" : "Short description of the action",
"definition" : "A short description of the action used to provide a summary to display to the user.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "RequestGroup.action.textEquivalent",
"path" : "RequestGroup.action.textEquivalent",
"short" : "Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system",
"definition" : "A text equivalent of the action to be performed. This provides a human-interpretable description of the action when the definition is consumed by a system that might not be capable of interpreting it dynamically.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "RequestGroup.action.priority",
"path" : "RequestGroup.action.priority",
"short" : "routine | urgent | asap | stat",
"definition" : "Indicates how quickly the action should be addressed with respect to other actions.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "code"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "RequestPriority"
}],
"strength" : "required",
"description" : "Identifies the level of importance to be assigned to actioning the request.",
"valueSet" : "http://hl7.org/fhir/ValueSet/request-priority|4.0.1"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.priority"
}]
},
{
"id" : "RequestGroup.action.code",
"path" : "RequestGroup.action.code",
"short" : "Code representing the meaning of the action or sub-actions",
"definition" : "A code that provides meaning for the action or action group. For example, a section may have a LOINC code for a section of a documentation template.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Request.code"
}]
},
{
"id" : "RequestGroup.action.documentation",
"path" : "RequestGroup.action.documentation",
"short" : "Supporting documentation for the intended performer of the action",
"definition" : "Didactic or other informational resources associated with the action that can be provided to the CDS recipient. Information resources can include inline text commentary and links to web resources.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "RelatedArtifact"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Request.supportingInfo"
}]
},
{
"id" : "RequestGroup.action.condition",
"path" : "RequestGroup.action.condition",
"short" : "Whether or not the action is applicable",
"definition" : "An expression that describes applicability criteria, or start/stop conditions for the action.",
"comment" : "When multiple conditions of the same kind are present, the effects are combined using AND semantics, so the overall condition is true only if all of the conditions are true.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "RequestGroup.action.condition.kind",
"path" : "RequestGroup.action.condition.kind",
"short" : "applicability | start | stop",
"definition" : "The kind of condition.",
"comment" : "Applicability criteria are used to determine immediate applicability when a plan definition is applied to a given context. Start and stop criteria are carried through application and used to describe enter/exit criteria for an action.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ActionConditionKind"
}],
"strength" : "required",
"description" : "The kind of condition for the action.",
"valueSet" : "http://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1"
}
},
{
"id" : "RequestGroup.action.condition.expression",
"path" : "RequestGroup.action.condition.expression",
"short" : "Boolean-valued expression",
"definition" : "An expression that returns true or false, indicating whether or not the condition is satisfied.",
"comment" : "The expression may be inlined, or may be a reference to a named expression within a logic library referenced by the library element.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Expression"
}]
},
{
"id" : "RequestGroup.action.relatedAction",
"path" : "RequestGroup.action.relatedAction",
"short" : "Relationship to another action",
"definition" : "A relationship to another action such as \"before\" or \"30-60 minutes after start of\".",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "RequestGroup.action.relatedAction.actionId",
"path" : "RequestGroup.action.relatedAction.actionId",
"short" : "What action this is related to",
"definition" : "The element id of the action this is related to.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "id"
}]
},
{
"id" : "RequestGroup.action.relatedAction.relationship",
"path" : "RequestGroup.action.relatedAction.relationship",
"short" : "before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end",
"definition" : "The relationship of this action to the related action.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ActionRelationshipType"
}],
"strength" : "required",
"description" : "Defines the types of relationships between actions.",
"valueSet" : "http://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1"
}
},
{
"id" : "RequestGroup.action.relatedAction.offset[x]",
"path" : "RequestGroup.action.relatedAction.offset[x]",
"short" : "Time offset for the relationship",
"definition" : "A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Duration"
},
{
"code" : "Range"
}]
},
{
"id" : "RequestGroup.action.timing[x]",
"path" : "RequestGroup.action.timing[x]",
"short" : "When the action should take place",
"definition" : "An optional value describing when the action should be performed.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "dateTime"
},
{
"code" : "Age"
},
{
"code" : "Period"
},
{
"code" : "Duration"
},
{
"code" : "Range"
},
{
"code" : "Timing"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Request.occurrence[x]"
}]
},
{
"id" : "RequestGroup.action.participant",
"path" : "RequestGroup.action.participant",
"short" : "Who should perform the action",
"definition" : "The participant that should perform or be responsible for this action.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson",
"http://hl7.org/fhir/StructureDefinition/Device"]
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Request.performer"
},
{
"identity" : "w5",
"map" : "FiveWs.actor"
}]
},
{
"id" : "RequestGroup.action.type",
"path" : "RequestGroup.action.type",
"short" : "create | update | remove | fire-event",
"definition" : "The type of action to perform (create, update, remove).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ActionType"
}],
"strength" : "extensible",
"description" : "The type of action to be performed.",
"valueSet" : "http://hl7.org/fhir/ValueSet/action-type"
}
},
{
"id" : "RequestGroup.action.groupingBehavior",
"path" : "RequestGroup.action.groupingBehavior",
"short" : "visual-group | logical-group | sentence-group",
"definition" : "Defines the grouping behavior for the action and its children.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "code"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ActionGroupingBehavior"
}],
"strength" : "required",
"description" : "Defines organization behavior of a group.",
"valueSet" : "http://hl7.org/fhir/ValueSet/action-grouping-behavior|4.0.1"
}
},
{
"id" : "RequestGroup.action.selectionBehavior",
"path" : "RequestGroup.action.selectionBehavior",
"short" : "any | all | all-or-none | exactly-one | at-most-one | one-or-more",
"definition" : "Defines the selection behavior for the action and its children.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "code"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ActionSelectionBehavior"
}],
"strength" : "required",
"description" : "Defines selection behavior of a group.",
"valueSet" : "http://hl7.org/fhir/ValueSet/action-selection-behavior|4.0.1"
}
},
{
"id" : "RequestGroup.action.requiredBehavior",
"path" : "RequestGroup.action.requiredBehavior",
"short" : "must | could | must-unless-documented",
"definition" : "Defines expectations around whether an action is required.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "code"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ActionRequiredBehavior"
}],
"strength" : "required",
"description" : "Defines expectations around whether an action or action group is required.",
"valueSet" : "http://hl7.org/fhir/ValueSet/action-required-behavior|4.0.1"
}
},
{
"id" : "RequestGroup.action.precheckBehavior",
"path" : "RequestGroup.action.precheckBehavior",
"short" : "yes | no",
"definition" : "Defines whether the action should usually be preselected.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "code"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ActionPrecheckBehavior"
}],
"strength" : "required",
"description" : "Defines selection frequency behavior for an action or group.",
"valueSet" : "http://hl7.org/fhir/ValueSet/action-precheck-behavior|4.0.1"
}
},
{
"id" : "RequestGroup.action.cardinalityBehavior",
"path" : "RequestGroup.action.cardinalityBehavior",
"short" : "single | multiple",
"definition" : "Defines whether the action can be selected multiple times.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "code"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ActionCardinalityBehavior"
}],
"strength" : "required",
"description" : "Defines behavior for an action or a group for how many times that item may be repeated.",
"valueSet" : "http://hl7.org/fhir/ValueSet/action-cardinality-behavior|4.0.1"
}
},
{
"id" : "RequestGroup.action.resource",
"path" : "RequestGroup.action.resource",
"short" : "The target of the action",
"definition" : "The resource that is the target of the action (e.g. CommunicationRequest).",
"comment" : "The target resource SHALL be a [Request](request.html) resource with a Request.intent set to \"option\".",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"condition" : ["rqg-1"]
},
{
"id" : "RequestGroup.action.action",
"path" : "RequestGroup.action.action",
"short" : "Sub action",
"definition" : "Sub actions.",
"min" : 0,
"max" : "*",
"contentReference" : "#RequestGroup.action",
"condition" : ["rqg-1"]
}]
}
}
},
{
"fullUrl" : "http://hl7.org/fhir/StructureDefinition/ResearchDefinition",
"resource" : {
"resourceType" : "StructureDefinition",
"id" : "ResearchDefinition",
"meta" : {
"lastUpdated" : "2019-11-01T09:29:23.356+11:00"
},
"text" : {
"status" : "generated",
"div" : "Name Flags Card. Type Description & Constraints ResearchDefinition ITU DomainResource A research context or question
+ 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 url Σ 0..1 uri Canonical identifier for this research definition, represented as a URI (globally unique) identifier Σ 0..* Identifier Additional identifier for the research definition
version Σ 0..1 string Business version of the research definition name ΣI 0..1 string Name for this research definition (computer friendly) title Σ 0..1 string Name for this research definition (human friendly) shortTitle 0..1 string Title for use in informal contexts subtitle 0..1 string Subordinate title of the ResearchDefinition status ?!Σ 1..1 code draft | active | retired | unknown
PublicationStatus (Required) experimental Σ 0..1 boolean For testing purposes, not real usage subject[x] 0..1 E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
Subject type (Extensible) subjectCodeableConcept CodeableConcept subjectReference Reference(Group) date Σ 0..1 dateTime Date last changed publisher Σ 0..1 string Name of the publisher (organization or individual) contact Σ 0..* ContactDetail Contact details for the publisher
description Σ 0..1 markdown Natural language description of the research definition comment 0..* string Used for footnotes or explanatory notes
useContext Σ 0..* UsageContext The context that the content is intended to support
jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for research definition (if applicable)
Jurisdiction (Extensible)
purpose 0..1 markdown Why this research definition is defined usage 0..1 string Describes the clinical usage of the ResearchDefinition copyright 0..1 markdown Use and/or publishing restrictions approvalDate 0..1 date When the research definition was approved by publisher lastReviewDate 0..1 date When the research definition was last reviewed effectivePeriod Σ 0..1 Period When the research definition is expected to be used topic 0..* CodeableConcept The category of the ResearchDefinition, such as Education, Treatment, Assessment, etc.
DefinitionTopic (Example)
author 0..* ContactDetail Who authored the content
editor 0..* ContactDetail Who edited the content
reviewer 0..* ContactDetail Who reviewed the content
endorser 0..* ContactDetail Who endorsed the content
relatedArtifact 0..* RelatedArtifact Additional documentation, citations, etc.
library 0..* canonical(Library) Logic used by the ResearchDefinition
population Σ 1..1 Reference(ResearchElementDefinition) What population? exposure Σ 0..1 Reference(ResearchElementDefinition) What exposure? exposureAlternative Σ 0..1 Reference(ResearchElementDefinition) What alternative exposure state? outcome Σ 0..1 Reference(ResearchElementDefinition) What outcome?
Documentation for this format
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Specialized.Evidence-Based Medicine"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 0
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "business"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "cds"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/ResearchDefinition",
"version" : "4.0.1",
"name" : "ResearchDefinition",
"status" : "draft",
"date" : "2019-11-01T09:29:23+11:00",
"publisher" : "Health Level Seven International (Clinical Decision Support)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/dss/index.cfm"
}]
}],
"description" : "The ResearchDefinition resource describes the conditional state (population and any exposures being compared within the population) and outcome (if specified) that the knowledge (evidence, assertion, recommendation) is about.",
"fhirVersion" : "4.0.1",
"mapping" : [{
"identity" : "workflow",
"uri" : "http://hl7.org/fhir/workflow",
"name" : "Workflow Pattern"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/fivews",
"name" : "FiveWs Pattern Mapping"
},
{
"identity" : "objimpl",
"uri" : "http://hl7.org/fhir/object-implementation",
"name" : "Object Implementation Information"
},
{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
}],
"kind" : "resource",
"abstract" : false,
"type" : "ResearchDefinition",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"_baseDefinition" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-codegen-super",
"valueString" : "MetadataResource"
}]
},
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "ResearchDefinition",
"path" : "ResearchDefinition",
"short" : "A research context or question",
"definition" : "The ResearchDefinition resource describes the conditional state (population and any exposures being compared within the population) and outcome (if specified) that the knowledge (evidence, assertion, recommendation) is about.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ResearchDefinition",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "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",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.`div`.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "rsd-0",
"severity" : "warning",
"human" : "Name should be usable as an identifier for the module by machine processing applications such as code generation",
"expression" : "name.matches('[A-Z]([A-Za-z0-9_]){0,254}')",
"xpath" : "not(exists(f:name/@value)) or matches(f:name/@value, '[A-Z]([A-Za-z0-9_]){0,254}')"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "workflow",
"map" : "Definition"
}]
},
{
"id" : "ResearchDefinition.id",
"path" : "ResearchDefinition.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "ResearchDefinition.meta",
"path" : "ResearchDefinition.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "ResearchDefinition.implicitRules",
"path" : "ResearchDefinition.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "ResearchDefinition.language",
"path" : "ResearchDefinition.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "ResearchDefinition.text",
"path" : "ResearchDefinition.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "ResearchDefinition.contained",
"path" : "ResearchDefinition.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ResearchDefinition.extension",
"path" : "ResearchDefinition.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ResearchDefinition.modifierExtension",
"path" : "ResearchDefinition.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ResearchDefinition.url",
"path" : "ResearchDefinition.url",
"short" : "Canonical identifier for this research definition, represented as a URI (globally unique)",
"definition" : "An absolute URI that is used to identify this research definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this research definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the research definition is stored on different servers.",
"comment" : "Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.\n\nThe determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions). \n\nIn some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.",
"requirements" : "Allows the research definition to be referenced by a single globally unique identifier.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ResearchDefinition.url",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.url"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
}]
},
{
"id" : "ResearchDefinition.identifier",
"path" : "ResearchDefinition.identifier",
"short" : "Additional identifier for the research definition",
"definition" : "A formal identifier that is used to identify this research definition when it is represented in other formats, or referenced in a specification, model, design or an instance.",
"comment" : "Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this research definition outside of FHIR, where it is not possible to use the logical URI.",
"requirements" : "Allows externally provided and/or usable business identifiers to be easily associated with the module.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ResearchDefinition.identifier",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Identifier"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.identifier"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "ResearchDefinition.version",
"path" : "ResearchDefinition.version",
"short" : "Business version of the research definition",
"definition" : "The identifier that is used to identify this version of the research definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the research definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts.",
"comment" : "There may be different research definition instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the research definition with the format [url]|[version].",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ResearchDefinition.version",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.version"
},
{
"identity" : "w5",
"map" : "FiveWs.version"
}]
},
{
"id" : "ResearchDefinition.name",
"path" : "ResearchDefinition.name",
"short" : "Name for this research definition (computer friendly)",
"definition" : "A natural language name identifying the research definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.",
"comment" : "The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.",
"requirements" : "Support human navigation and code generation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ResearchDefinition.name",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"condition" : ["inv-0"],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "ResearchDefinition.title",
"path" : "ResearchDefinition.title",
"short" : "Name for this research definition (human friendly)",
"definition" : "A short, descriptive, user-friendly title for the research definition.",
"comment" : "This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ResearchDefinition.title",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.title"
}]
},
{
"id" : "ResearchDefinition.shortTitle",
"path" : "ResearchDefinition.shortTitle",
"short" : "Title for use in informal contexts",
"definition" : "The short title provides an alternate title for use in informal descriptive contexts where the full, formal title is not necessary.",
"requirements" : "Need to be able to reference the content by a short description, but still provide a longer, more formal title for the content.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ResearchDefinition.shortTitle",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ResearchDefinition.subtitle",
"path" : "ResearchDefinition.subtitle",
"short" : "Subordinate title of the ResearchDefinition",
"definition" : "An explanatory or alternate title for the ResearchDefinition giving additional information about its content.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ResearchDefinition.subtitle",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ResearchDefinition.status",
"path" : "ResearchDefinition.status",
"short" : "draft | active | retired | unknown",
"definition" : "The status of this research definition. Enables tracking the life-cycle of the content.",
"comment" : "Allows filtering of research definitions that are appropriate for use versus not.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ResearchDefinition.status",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This is labeled as \"Is Modifier\" because applications should not use a retired {{title}} without due consideration",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "PublicationStatus"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "The lifecycle status of an artifact.",
"valueSet" : "http://hl7.org/fhir/ValueSet/publication-status|4.0.1"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.status"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
}]
},
{
"id" : "ResearchDefinition.experimental",
"path" : "ResearchDefinition.experimental",
"short" : "For testing purposes, not real usage",
"definition" : "A Boolean value to indicate that this research definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.",
"comment" : "Allows filtering of research definitions that are appropriate for use versus not.",
"requirements" : "Enables experimental content to be developed following the same lifecycle that would be used for a production-level research definition.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ResearchDefinition.experimental",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.experimental"
},
{
"identity" : "w5",
"map" : "FiveWs.class"
}]
},
{
"id" : "ResearchDefinition.subject[x]",
"path" : "ResearchDefinition.subject[x]",
"short" : "E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device",
"definition" : "The intended subjects for the ResearchDefinition. If this element is not provided, a Patient subject is assumed, but the subject of the ResearchDefinition can be anything.",
"comment" : "The subject of the ResearchDefinition is critical in interpreting the criteria definitions, as the logic in the ResearchDefinitions is evaluated with respect to a particular subject. This corresponds roughly to the notion of a Compartment in that it limits what content is available based on its relationship to the subject. In CQL, this corresponds to the context declaration.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ResearchDefinition.subject[x]",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
},
{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Group"]
}],
"meaningWhenMissing" : "Patient",
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SubjectType"
}],
"strength" : "extensible",
"description" : "The possible types of subjects for the research (E.g. Patient, Practitioner, Organization, Location, etc.).",
"valueSet" : "http://hl7.org/fhir/ValueSet/subject-type"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.subject"
}]
},
{
"id" : "ResearchDefinition.date",
"path" : "ResearchDefinition.date",
"short" : "Date last changed",
"definition" : "The date (and optionally time) when the research definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the research definition changes.",
"comment" : "Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the research definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.",
"alias" : ["Revision Date"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "ResearchDefinition.date",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.date"
},
{
"identity" : "w5",
"map" : "FiveWs.recorded"
}]
},
{
"id" : "ResearchDefinition.publisher",
"path" : "ResearchDefinition.publisher",
"short" : "Name of the publisher (organization or individual)",
"definition" : "The name of the organization or individual that published the research definition.",
"comment" : "Usually an organization but may be an individual. The publisher (or steward) of the research definition is the organization or individual primarily responsible for the maintenance and upkeep of the research definition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the research definition. This item SHOULD be populated unless the information is available from context.",
"requirements" : "Helps establish the \"authority/credibility\" of the research definition. May also allow for contact.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ResearchDefinition.publisher",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.publisher"
},
{
"identity" : "w5",
"map" : "FiveWs.witness"
}]
},
{
"id" : "ResearchDefinition.contact",
"path" : "ResearchDefinition.contact",
"short" : "Contact details for the publisher",
"definition" : "Contact details to assist a user in finding and communicating with the publisher.",
"comment" : "May be a web site, an email address, a telephone number, etc.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ResearchDefinition.contact",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "ContactDetail"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.contact"
}]
},
{
"id" : "ResearchDefinition.description",
"path" : "ResearchDefinition.description",
"short" : "Natural language description of the research definition",
"definition" : "A free text natural language description of the research definition from a consumer's perspective.",
"comment" : "This description can be used to capture details such as why the research definition was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the research definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the research definition is presumed to be the predominant language in the place the research definition was created).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ResearchDefinition.description",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "markdown"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.description"
}]
},
{
"id" : "ResearchDefinition.comment",
"path" : "ResearchDefinition.comment",
"short" : "Used for footnotes or explanatory notes",
"definition" : "A human-readable string to clarify or explain concepts about the resource.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ResearchDefinition.comment",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ResearchDefinition.useContext",
"path" : "ResearchDefinition.useContext",
"short" : "The context that the content is intended to support",
"definition" : "The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate research definition instances.",
"comment" : "When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.",
"requirements" : "Assist in searching for appropriate content.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ResearchDefinition.useContext",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "UsageContext"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.useContext"
}]
},
{
"id" : "ResearchDefinition.jurisdiction",
"path" : "ResearchDefinition.jurisdiction",
"short" : "Intended jurisdiction for research definition (if applicable)",
"definition" : "A legal or geographic region in which the research definition is intended to be used.",
"comment" : "It may be possible for the research definition to be used in jurisdictions other than those for which it was originally designed or intended.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ResearchDefinition.jurisdiction",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Jurisdiction"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "extensible",
"description" : "Countries and regions within which this artifact is targeted for use.",
"valueSet" : "http://hl7.org/fhir/ValueSet/jurisdiction"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.jurisdiction"
}]
},
{
"id" : "ResearchDefinition.purpose",
"path" : "ResearchDefinition.purpose",
"short" : "Why this research definition is defined",
"definition" : "Explanation of why this research definition is needed and why it has been designed as it has.",
"comment" : "This element does not describe the usage of the research definition. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this research definition.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ResearchDefinition.purpose",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "markdown"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.purpose"
},
{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "ResearchDefinition.usage",
"path" : "ResearchDefinition.usage",
"short" : "Describes the clinical usage of the ResearchDefinition",
"definition" : "A detailed description, from a clinical perspective, of how the ResearchDefinition is used.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ResearchDefinition.usage",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ResearchDefinition.copyright",
"path" : "ResearchDefinition.copyright",
"short" : "Use and/or publishing restrictions",
"definition" : "A copyright statement relating to the research definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the research definition.",
"requirements" : "Consumers must be able to determine any legal restrictions on the use of the research definition and/or its content.",
"alias" : ["License",
"Restrictions"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "ResearchDefinition.copyright",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "markdown"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.copyright"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "ResearchDefinition.approvalDate",
"path" : "ResearchDefinition.approvalDate",
"short" : "When the research definition was approved by publisher",
"definition" : "The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.",
"comment" : "The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ResearchDefinition.approvalDate",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "date"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.approvalDate"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "ResearchDefinition.lastReviewDate",
"path" : "ResearchDefinition.lastReviewDate",
"short" : "When the research definition was last reviewed",
"definition" : "The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.",
"comment" : "If specified, this date follows the original approval date.",
"requirements" : "Gives a sense of how \"current\" the content is. Resources that have not been reviewed in a long time may have a risk of being less appropriate/relevant.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ResearchDefinition.lastReviewDate",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "date"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.lastReviewDate"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "ResearchDefinition.effectivePeriod",
"path" : "ResearchDefinition.effectivePeriod",
"short" : "When the research definition is expected to be used",
"definition" : "The period during which the research definition content was or is planned to be in active use.",
"comment" : "The effective period for a research definition determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 might be published in 2015.",
"requirements" : "Allows establishing a transition before a resource comes into effect and also allows for a sunsetting process when new versions of the research definition are or are expected to be used instead.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ResearchDefinition.effectivePeriod",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Period"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.effectivePeriod"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "ResearchDefinition.topic",
"path" : "ResearchDefinition.topic",
"short" : "The category of the ResearchDefinition, such as Education, Treatment, Assessment, etc.",
"definition" : "Descriptive topics related to the content of the ResearchDefinition. Topics provide a high-level categorization grouping types of ResearchDefinitions that can be useful for filtering and searching.",
"requirements" : "Repositories must be able to determine how to categorize the ResearchDefinition so that it can be found by topical searches.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ResearchDefinition.topic",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "DefinitionTopic"
}],
"strength" : "example",
"description" : "High-level categorization of the definition, used for searching, sorting, and filtering.",
"valueSet" : "http://hl7.org/fhir/ValueSet/definition-topic"
}
},
{
"id" : "ResearchDefinition.author",
"path" : "ResearchDefinition.author",
"short" : "Who authored the content",
"definition" : "An individiual or organization primarily involved in the creation and maintenance of the content.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ResearchDefinition.author",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "ContactDetail"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".participation[typeCode=AUT]"
}]
},
{
"id" : "ResearchDefinition.editor",
"path" : "ResearchDefinition.editor",
"short" : "Who edited the content",
"definition" : "An individual or organization primarily responsible for internal coherence of the content.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ResearchDefinition.editor",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "ContactDetail"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ResearchDefinition.reviewer",
"path" : "ResearchDefinition.reviewer",
"short" : "Who reviewed the content",
"definition" : "An individual or organization primarily responsible for review of some aspect of the content.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ResearchDefinition.reviewer",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "ContactDetail"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".participation[typeCode=VRF] {not clear whether VRF best corresponds to reviewer or endorser}"
}]
},
{
"id" : "ResearchDefinition.endorser",
"path" : "ResearchDefinition.endorser",
"short" : "Who endorsed the content",
"definition" : "An individual or organization responsible for officially endorsing the content for use in some setting.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ResearchDefinition.endorser",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "ContactDetail"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".participation[typeCode=VRF] {not clear whether VRF best corresponds to reviewer or endorser}"
}]
},
{
"id" : "ResearchDefinition.relatedArtifact",
"path" : "ResearchDefinition.relatedArtifact",
"short" : "Additional documentation, citations, etc.",
"definition" : "Related artifacts such as additional documentation, justification, or bibliographic references.",
"comment" : "Each related artifact is either an attachment, or a reference to another resource, but not both.",
"requirements" : "ResearchDefinitions must be able to provide enough information for consumers of the content (and/or interventions or results produced by the content) to be able to determine and understand the justification for and evidence in support of the content.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ResearchDefinition.relatedArtifact",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "RelatedArtifact"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ResearchDefinition.library",
"path" : "ResearchDefinition.library",
"short" : "Logic used by the ResearchDefinition",
"definition" : "A reference to a Library resource containing the formal logic used by the ResearchDefinition.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ResearchDefinition.library",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Library"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ResearchDefinition.population",
"path" : "ResearchDefinition.population",
"short" : "What population?",
"definition" : "A reference to a ResearchElementDefinition resource that defines the population for the research.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ResearchDefinition.population",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ResearchElementDefinition"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "ResearchDefinition.exposure",
"path" : "ResearchDefinition.exposure",
"short" : "What exposure?",
"definition" : "A reference to a ResearchElementDefinition resource that defines the exposure for the research.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ResearchDefinition.exposure",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ResearchElementDefinition"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "ResearchDefinition.exposureAlternative",
"path" : "ResearchDefinition.exposureAlternative",
"short" : "What alternative exposure state?",
"definition" : "A reference to a ResearchElementDefinition resource that defines the exposureAlternative for the research.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ResearchDefinition.exposureAlternative",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ResearchElementDefinition"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "ResearchDefinition.outcome",
"path" : "ResearchDefinition.outcome",
"short" : "What outcome?",
"definition" : "A reference to a ResearchElementDefinition resomece that defines the outcome for the research.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ResearchDefinition.outcome",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ResearchElementDefinition"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
}]
},
"differential" : {
"element" : [{
"id" : "ResearchDefinition",
"path" : "ResearchDefinition",
"short" : "A research context or question",
"definition" : "The ResearchDefinition resource describes the conditional state (population and any exposures being compared within the population) and outcome (if specified) that the knowledge (evidence, assertion, recommendation) is about.",
"min" : 0,
"max" : "*",
"constraint" : [{
"key" : "rsd-0",
"severity" : "warning",
"human" : "Name should be usable as an identifier for the module by machine processing applications such as code generation",
"expression" : "name.matches('[A-Z]([A-Za-z0-9_]){0,254}')",
"xpath" : "not(exists(f:name/@value)) or matches(f:name/@value, '[A-Z]([A-Za-z0-9_]){0,254}')"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Definition"
}]
},
{
"id" : "ResearchDefinition.url",
"path" : "ResearchDefinition.url",
"short" : "Canonical identifier for this research definition, represented as a URI (globally unique)",
"definition" : "An absolute URI that is used to identify this research definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this research definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the research definition is stored on different servers.",
"comment" : "Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.\n\nThe determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions). \n\nIn some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.",
"requirements" : "Allows the research definition to be referenced by a single globally unique identifier.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "uri"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.url"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
}]
},
{
"id" : "ResearchDefinition.identifier",
"path" : "ResearchDefinition.identifier",
"short" : "Additional identifier for the research definition",
"definition" : "A formal identifier that is used to identify this research definition when it is represented in other formats, or referenced in a specification, model, design or an instance.",
"comment" : "Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this research definition outside of FHIR, where it is not possible to use the logical URI.",
"requirements" : "Allows externally provided and/or usable business identifiers to be easily associated with the module.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Identifier"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.identifier"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "ResearchDefinition.version",
"path" : "ResearchDefinition.version",
"short" : "Business version of the research definition",
"definition" : "The identifier that is used to identify this version of the research definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the research definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts.",
"comment" : "There may be different research definition instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the research definition with the format [url]|[version].",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.version"
},
{
"identity" : "w5",
"map" : "FiveWs.version"
}]
},
{
"id" : "ResearchDefinition.name",
"path" : "ResearchDefinition.name",
"short" : "Name for this research definition (computer friendly)",
"definition" : "A natural language name identifying the research definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.",
"comment" : "The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.",
"requirements" : "Support human navigation and code generation.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"condition" : ["inv-0"],
"isSummary" : true
},
{
"id" : "ResearchDefinition.title",
"path" : "ResearchDefinition.title",
"short" : "Name for this research definition (human friendly)",
"definition" : "A short, descriptive, user-friendly title for the research definition.",
"comment" : "This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.title"
}]
},
{
"id" : "ResearchDefinition.shortTitle",
"path" : "ResearchDefinition.shortTitle",
"short" : "Title for use in informal contexts",
"definition" : "The short title provides an alternate title for use in informal descriptive contexts where the full, formal title is not necessary.",
"requirements" : "Need to be able to reference the content by a short description, but still provide a longer, more formal title for the content.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}]
},
{
"id" : "ResearchDefinition.subtitle",
"path" : "ResearchDefinition.subtitle",
"short" : "Subordinate title of the ResearchDefinition",
"definition" : "An explanatory or alternate title for the ResearchDefinition giving additional information about its content.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}]
},
{
"id" : "ResearchDefinition.status",
"path" : "ResearchDefinition.status",
"short" : "draft | active | retired | unknown",
"definition" : "The status of this research definition. Enables tracking the life-cycle of the content.",
"comment" : "Allows filtering of research definitions that are appropriate for use versus not.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isModifier" : true,
"isModifierReason" : "This is labeled as \"Is Modifier\" because applications should not use a retired {{title}} without due consideration",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "PublicationStatus"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "The lifecycle status of an artifact.",
"valueSet" : "http://hl7.org/fhir/ValueSet/publication-status|4.0.1"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.status"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
}]
},
{
"id" : "ResearchDefinition.experimental",
"path" : "ResearchDefinition.experimental",
"short" : "For testing purposes, not real usage",
"definition" : "A Boolean value to indicate that this research definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.",
"comment" : "Allows filtering of research definitions that are appropriate for use versus not.",
"requirements" : "Enables experimental content to be developed following the same lifecycle that would be used for a production-level research definition.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "boolean"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.experimental"
},
{
"identity" : "w5",
"map" : "FiveWs.class"
}]
},
{
"id" : "ResearchDefinition.subject[x]",
"path" : "ResearchDefinition.subject[x]",
"short" : "E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device",
"definition" : "The intended subjects for the ResearchDefinition. If this element is not provided, a Patient subject is assumed, but the subject of the ResearchDefinition can be anything.",
"comment" : "The subject of the ResearchDefinition is critical in interpreting the criteria definitions, as the logic in the ResearchDefinitions is evaluated with respect to a particular subject. This corresponds roughly to the notion of a Compartment in that it limits what content is available based on its relationship to the subject. In CQL, this corresponds to the context declaration.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
},
{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Group"]
}],
"meaningWhenMissing" : "Patient",
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SubjectType"
}],
"strength" : "extensible",
"description" : "The possible types of subjects for the research (E.g. Patient, Practitioner, Organization, Location, etc.).",
"valueSet" : "http://hl7.org/fhir/ValueSet/subject-type"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.subject"
}]
},
{
"id" : "ResearchDefinition.date",
"path" : "ResearchDefinition.date",
"short" : "Date last changed",
"definition" : "The date (and optionally time) when the research definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the research definition changes.",
"comment" : "Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the research definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.",
"alias" : ["Revision Date"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "dateTime"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.date"
},
{
"identity" : "w5",
"map" : "FiveWs.recorded"
}]
},
{
"id" : "ResearchDefinition.publisher",
"path" : "ResearchDefinition.publisher",
"short" : "Name of the publisher (organization or individual)",
"definition" : "The name of the organization or individual that published the research definition.",
"comment" : "Usually an organization but may be an individual. The publisher (or steward) of the research definition is the organization or individual primarily responsible for the maintenance and upkeep of the research definition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the research definition. This item SHOULD be populated unless the information is available from context.",
"requirements" : "Helps establish the \"authority/credibility\" of the research definition. May also allow for contact.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.publisher"
},
{
"identity" : "w5",
"map" : "FiveWs.witness"
}]
},
{
"id" : "ResearchDefinition.contact",
"path" : "ResearchDefinition.contact",
"short" : "Contact details for the publisher",
"definition" : "Contact details to assist a user in finding and communicating with the publisher.",
"comment" : "May be a web site, an email address, a telephone number, etc.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "ContactDetail"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.contact"
}]
},
{
"id" : "ResearchDefinition.description",
"path" : "ResearchDefinition.description",
"short" : "Natural language description of the research definition",
"definition" : "A free text natural language description of the research definition from a consumer's perspective.",
"comment" : "This description can be used to capture details such as why the research definition was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the research definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the research definition is presumed to be the predominant language in the place the research definition was created).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "markdown"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.description"
}]
},
{
"id" : "ResearchDefinition.comment",
"path" : "ResearchDefinition.comment",
"short" : "Used for footnotes or explanatory notes",
"definition" : "A human-readable string to clarify or explain concepts about the resource.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "string"
}]
},
{
"id" : "ResearchDefinition.useContext",
"path" : "ResearchDefinition.useContext",
"short" : "The context that the content is intended to support",
"definition" : "The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate research definition instances.",
"comment" : "When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.",
"requirements" : "Assist in searching for appropriate content.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "UsageContext"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.useContext"
}]
},
{
"id" : "ResearchDefinition.jurisdiction",
"path" : "ResearchDefinition.jurisdiction",
"short" : "Intended jurisdiction for research definition (if applicable)",
"definition" : "A legal or geographic region in which the research definition is intended to be used.",
"comment" : "It may be possible for the research definition to be used in jurisdictions other than those for which it was originally designed or intended.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Jurisdiction"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "extensible",
"description" : "Countries and regions within which this artifact is targeted for use.",
"valueSet" : "http://hl7.org/fhir/ValueSet/jurisdiction"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.jurisdiction"
}]
},
{
"id" : "ResearchDefinition.purpose",
"path" : "ResearchDefinition.purpose",
"short" : "Why this research definition is defined",
"definition" : "Explanation of why this research definition is needed and why it has been designed as it has.",
"comment" : "This element does not describe the usage of the research definition. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this research definition.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "markdown"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.purpose"
},
{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "ResearchDefinition.usage",
"path" : "ResearchDefinition.usage",
"short" : "Describes the clinical usage of the ResearchDefinition",
"definition" : "A detailed description, from a clinical perspective, of how the ResearchDefinition is used.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}]
},
{
"id" : "ResearchDefinition.copyright",
"path" : "ResearchDefinition.copyright",
"short" : "Use and/or publishing restrictions",
"definition" : "A copyright statement relating to the research definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the research definition.",
"requirements" : "Consumers must be able to determine any legal restrictions on the use of the research definition and/or its content.",
"alias" : ["License",
"Restrictions"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "markdown"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.copyright"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "ResearchDefinition.approvalDate",
"path" : "ResearchDefinition.approvalDate",
"short" : "When the research definition was approved by publisher",
"definition" : "The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.",
"comment" : "The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "date"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.approvalDate"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "ResearchDefinition.lastReviewDate",
"path" : "ResearchDefinition.lastReviewDate",
"short" : "When the research definition was last reviewed",
"definition" : "The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.",
"comment" : "If specified, this date follows the original approval date.",
"requirements" : "Gives a sense of how \"current\" the content is. Resources that have not been reviewed in a long time may have a risk of being less appropriate/relevant.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "date"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.lastReviewDate"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "ResearchDefinition.effectivePeriod",
"path" : "ResearchDefinition.effectivePeriod",
"short" : "When the research definition is expected to be used",
"definition" : "The period during which the research definition content was or is planned to be in active use.",
"comment" : "The effective period for a research definition determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 might be published in 2015.",
"requirements" : "Allows establishing a transition before a resource comes into effect and also allows for a sunsetting process when new versions of the research definition are or are expected to be used instead.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Period"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.effectivePeriod"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "ResearchDefinition.topic",
"path" : "ResearchDefinition.topic",
"short" : "The category of the ResearchDefinition, such as Education, Treatment, Assessment, etc.",
"definition" : "Descriptive topics related to the content of the ResearchDefinition. Topics provide a high-level categorization grouping types of ResearchDefinitions that can be useful for filtering and searching.",
"requirements" : "Repositories must be able to determine how to categorize the ResearchDefinition so that it can be found by topical searches.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "DefinitionTopic"
}],
"strength" : "example",
"description" : "High-level categorization of the definition, used for searching, sorting, and filtering.",
"valueSet" : "http://hl7.org/fhir/ValueSet/definition-topic"
}
},
{
"id" : "ResearchDefinition.author",
"path" : "ResearchDefinition.author",
"short" : "Who authored the content",
"definition" : "An individiual or organization primarily involved in the creation and maintenance of the content.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "ContactDetail"
}],
"mapping" : [{
"identity" : "rim",
"map" : ".participation[typeCode=AUT]"
}]
},
{
"id" : "ResearchDefinition.editor",
"path" : "ResearchDefinition.editor",
"short" : "Who edited the content",
"definition" : "An individual or organization primarily responsible for internal coherence of the content.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "ContactDetail"
}]
},
{
"id" : "ResearchDefinition.reviewer",
"path" : "ResearchDefinition.reviewer",
"short" : "Who reviewed the content",
"definition" : "An individual or organization primarily responsible for review of some aspect of the content.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "ContactDetail"
}],
"mapping" : [{
"identity" : "rim",
"map" : ".participation[typeCode=VRF] {not clear whether VRF best corresponds to reviewer or endorser}"
}]
},
{
"id" : "ResearchDefinition.endorser",
"path" : "ResearchDefinition.endorser",
"short" : "Who endorsed the content",
"definition" : "An individual or organization responsible for officially endorsing the content for use in some setting.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "ContactDetail"
}],
"mapping" : [{
"identity" : "rim",
"map" : ".participation[typeCode=VRF] {not clear whether VRF best corresponds to reviewer or endorser}"
}]
},
{
"id" : "ResearchDefinition.relatedArtifact",
"path" : "ResearchDefinition.relatedArtifact",
"short" : "Additional documentation, citations, etc.",
"definition" : "Related artifacts such as additional documentation, justification, or bibliographic references.",
"comment" : "Each related artifact is either an attachment, or a reference to another resource, but not both.",
"requirements" : "ResearchDefinitions must be able to provide enough information for consumers of the content (and/or interventions or results produced by the content) to be able to determine and understand the justification for and evidence in support of the content.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "RelatedArtifact"
}]
},
{
"id" : "ResearchDefinition.library",
"path" : "ResearchDefinition.library",
"short" : "Logic used by the ResearchDefinition",
"definition" : "A reference to a Library resource containing the formal logic used by the ResearchDefinition.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Library"]
}]
},
{
"id" : "ResearchDefinition.population",
"path" : "ResearchDefinition.population",
"short" : "What population?",
"definition" : "A reference to a ResearchElementDefinition resource that defines the population for the research.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ResearchElementDefinition"]
}],
"isSummary" : true
},
{
"id" : "ResearchDefinition.exposure",
"path" : "ResearchDefinition.exposure",
"short" : "What exposure?",
"definition" : "A reference to a ResearchElementDefinition resource that defines the exposure for the research.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ResearchElementDefinition"]
}],
"isSummary" : true
},
{
"id" : "ResearchDefinition.exposureAlternative",
"path" : "ResearchDefinition.exposureAlternative",
"short" : "What alternative exposure state?",
"definition" : "A reference to a ResearchElementDefinition resource that defines the exposureAlternative for the research.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ResearchElementDefinition"]
}],
"isSummary" : true
},
{
"id" : "ResearchDefinition.outcome",
"path" : "ResearchDefinition.outcome",
"short" : "What outcome?",
"definition" : "A reference to a ResearchElementDefinition resomece that defines the outcome for the research.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ResearchElementDefinition"]
}],
"isSummary" : true
}]
}
}
},
{
"fullUrl" : "http://hl7.org/fhir/StructureDefinition/ResearchElementDefinition",
"resource" : {
"resourceType" : "StructureDefinition",
"id" : "ResearchElementDefinition",
"meta" : {
"lastUpdated" : "2019-11-01T09:29:23.356+11:00"
},
"text" : {
"status" : "generated",
"div" : "Name Flags Card. Type Description & Constraints ResearchElementDefinition ITU DomainResource A population, intervention, or exposure definition
+ 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 url Σ 0..1 uri Canonical identifier for this research element definition, represented as a URI (globally unique) identifier Σ 0..* Identifier Additional identifier for the research element definition
version Σ 0..1 string Business version of the research element definition name ΣI 0..1 string Name for this research element definition (computer friendly) title Σ 0..1 string Name for this research element definition (human friendly) shortTitle Σ 0..1 string Title for use in informal contexts subtitle 0..1 string Subordinate title of the ResearchElementDefinition status ?!Σ 1..1 code draft | active | retired | unknown
PublicationStatus (Required) experimental Σ 0..1 boolean For testing purposes, not real usage subject[x] 0..1 E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
Subject type (Extensible) subjectCodeableConcept CodeableConcept subjectReference Reference(Group) date Σ 0..1 dateTime Date last changed publisher Σ 0..1 string Name of the publisher (organization or individual) contact Σ 0..* ContactDetail Contact details for the publisher
description Σ 0..1 markdown Natural language description of the research element definition comment 0..* string Used for footnotes or explanatory notes
useContext Σ 0..* UsageContext The context that the content is intended to support
jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for research element definition (if applicable)
Jurisdiction (Extensible)
purpose 0..1 markdown Why this research element definition is defined usage 0..1 string Describes the clinical usage of the ResearchElementDefinition copyright 0..1 markdown Use and/or publishing restrictions approvalDate 0..1 date When the research element definition was approved by publisher lastReviewDate 0..1 date When the research element definition was last reviewed effectivePeriod Σ 0..1 Period When the research element definition is expected to be used topic 0..* CodeableConcept The category of the ResearchElementDefinition, such as Education, Treatment, Assessment, etc.
DefinitionTopic (Example)
author 0..* ContactDetail Who authored the content
editor 0..* ContactDetail Who edited the content
reviewer 0..* ContactDetail Who reviewed the content
endorser 0..* ContactDetail Who endorsed the content
relatedArtifact 0..* RelatedArtifact Additional documentation, citations, etc.
library 0..* canonical(Library) Logic used by the ResearchElementDefinition
type Σ 1..1 code population | exposure | outcome
ResearchElementType (Required) variableType 0..1 code dichotomous | continuous | descriptive
VariableType (Required) characteristic Σ 1..* BackboneElement What defines the members of the research element
definition[x] Σ 1..1 What code or expression defines members? definitionCodeableConcept CodeableConcept definitionCanonical canonical(ValueSet) definitionExpression Expression definitionDataRequirement DataRequirement usageContext 0..* UsageContext What code/value pairs define members?
exclude 0..1 boolean Whether the characteristic includes or excludes members unitOfMeasure 0..1 CodeableConcept What unit is the outcome described in?
UCUM Codes (Required) studyEffectiveDescription 0..1 string What time period does the study cover studyEffective[x] 0..1 What time period does the study cover studyEffectiveDateTime dateTime studyEffectivePeriod Period studyEffectiveDuration Duration studyEffectiveTiming Timing studyEffectiveTimeFromStart 0..1 Duration Observation time from study start studyEffectiveGroupMeasure 0..1 code mean | median | mean-of-mean | mean-of-median | median-of-mean | median-of-median
GroupMeasure (Required) participantEffectiveDescription 0..1 string What time period do participants cover participantEffective[x] 0..1 What time period do participants cover participantEffectiveDateTime dateTime participantEffectivePeriod Period participantEffectiveDuration Duration participantEffectiveTiming Timing participantEffectiveTimeFromStart 0..1 Duration Observation time from study start participantEffectiveGroupMeasure 0..1 code mean | median | mean-of-mean | mean-of-median | median-of-mean | median-of-median
GroupMeasure (Required)
Documentation for this format
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Specialized.Evidence-Based Medicine"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 0
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "business"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "cds"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/ResearchElementDefinition",
"version" : "4.0.1",
"name" : "ResearchElementDefinition",
"status" : "draft",
"date" : "2019-11-01T09:29:23+11:00",
"publisher" : "Health Level Seven International (Clinical Decision Support)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/dss/index.cfm"
}]
}],
"description" : "The ResearchElementDefinition resource describes a \"PICO\" element that knowledge (evidence, assertion, recommendation) is about.",
"purpose" : "Need to be able to define and reuse the definition of individual elements of a research question.",
"fhirVersion" : "4.0.1",
"mapping" : [{
"identity" : "workflow",
"uri" : "http://hl7.org/fhir/workflow",
"name" : "Workflow Pattern"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/fivews",
"name" : "FiveWs Pattern Mapping"
},
{
"identity" : "objimpl",
"uri" : "http://hl7.org/fhir/object-implementation",
"name" : "Object Implementation Information"
},
{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
}],
"kind" : "resource",
"abstract" : false,
"type" : "ResearchElementDefinition",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"_baseDefinition" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-codegen-super",
"valueString" : "MetadataResource"
}]
},
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "ResearchElementDefinition",
"path" : "ResearchElementDefinition",
"short" : "A population, intervention, or exposure definition",
"definition" : "The ResearchElementDefinition resource describes a \"PICO\" element that knowledge (evidence, assertion, recommendation) is about.",
"comment" : "PICO stands for Population (the population within which exposures are being compared), Intervention (the conditional state or exposure state being described for its effect on outcomes), Comparison (the alternative conditional state or alternative exposure state being compared against), and Outcome (the result or effect of the intervention in the population).",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ResearchElementDefinition",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "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",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.`div`.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "red-0",
"severity" : "warning",
"human" : "Name should be usable as an identifier for the module by machine processing applications such as code generation",
"expression" : "name.matches('[A-Z]([A-Za-z0-9_]){0,254}')",
"xpath" : "not(exists(f:name/@value)) or matches(f:name/@value, '[A-Z]([A-Za-z0-9_]){0,254}')"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "workflow",
"map" : "Definition"
}]
},
{
"id" : "ResearchElementDefinition.id",
"path" : "ResearchElementDefinition.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "ResearchElementDefinition.meta",
"path" : "ResearchElementDefinition.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "ResearchElementDefinition.implicitRules",
"path" : "ResearchElementDefinition.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "ResearchElementDefinition.language",
"path" : "ResearchElementDefinition.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "ResearchElementDefinition.text",
"path" : "ResearchElementDefinition.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "ResearchElementDefinition.contained",
"path" : "ResearchElementDefinition.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ResearchElementDefinition.extension",
"path" : "ResearchElementDefinition.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ResearchElementDefinition.modifierExtension",
"path" : "ResearchElementDefinition.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ResearchElementDefinition.url",
"path" : "ResearchElementDefinition.url",
"short" : "Canonical identifier for this research element definition, represented as a URI (globally unique)",
"definition" : "An absolute URI that is used to identify this research element definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this research element definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the research element definition is stored on different servers.",
"comment" : "Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.\n\nThe determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions). \n\nIn some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.",
"requirements" : "Allows the research element definition to be referenced by a single globally unique identifier.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ResearchElementDefinition.url",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.url"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
}]
},
{
"id" : "ResearchElementDefinition.identifier",
"path" : "ResearchElementDefinition.identifier",
"short" : "Additional identifier for the research element definition",
"definition" : "A formal identifier that is used to identify this research element definition when it is represented in other formats, or referenced in a specification, model, design or an instance.",
"comment" : "Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this research element definition outside of FHIR, where it is not possible to use the logical URI.",
"requirements" : "Allows externally provided and/or usable business identifiers to be easily associated with the module.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ResearchElementDefinition.identifier",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Identifier"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.identifier"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "ResearchElementDefinition.version",
"path" : "ResearchElementDefinition.version",
"short" : "Business version of the research element definition",
"definition" : "The identifier that is used to identify this version of the research element definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the research element definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts.",
"comment" : "There may be different research element definition instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the research element definition with the format [url]|[version].",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ResearchElementDefinition.version",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.version"
},
{
"identity" : "w5",
"map" : "FiveWs.version"
}]
},
{
"id" : "ResearchElementDefinition.name",
"path" : "ResearchElementDefinition.name",
"short" : "Name for this research element definition (computer friendly)",
"definition" : "A natural language name identifying the research element definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.",
"comment" : "The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.",
"requirements" : "Support human navigation and code generation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ResearchElementDefinition.name",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"condition" : ["inv-0"],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "ResearchElementDefinition.title",
"path" : "ResearchElementDefinition.title",
"short" : "Name for this research element definition (human friendly)",
"definition" : "A short, descriptive, user-friendly title for the research element definition.",
"comment" : "This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ResearchElementDefinition.title",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.title"
}]
},
{
"id" : "ResearchElementDefinition.shortTitle",
"path" : "ResearchElementDefinition.shortTitle",
"short" : "Title for use in informal contexts",
"definition" : "The short title provides an alternate title for use in informal descriptive contexts where the full, formal title is not necessary.",
"requirements" : "Need to be able to reference the content by a short description, but still provide a longer, more formal title for the content.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ResearchElementDefinition.shortTitle",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "ResearchElementDefinition.subtitle",
"path" : "ResearchElementDefinition.subtitle",
"short" : "Subordinate title of the ResearchElementDefinition",
"definition" : "An explanatory or alternate title for the ResearchElementDefinition giving additional information about its content.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ResearchElementDefinition.subtitle",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ResearchElementDefinition.status",
"path" : "ResearchElementDefinition.status",
"short" : "draft | active | retired | unknown",
"definition" : "The status of this research element definition. Enables tracking the life-cycle of the content.",
"comment" : "Allows filtering of research element definitions that are appropriate for use versus not.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ResearchElementDefinition.status",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This is labeled as \"Is Modifier\" because applications should not use a retired {{title}} without due consideration",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "PublicationStatus"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "The lifecycle status of an artifact.",
"valueSet" : "http://hl7.org/fhir/ValueSet/publication-status|4.0.1"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.status"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
}]
},
{
"id" : "ResearchElementDefinition.experimental",
"path" : "ResearchElementDefinition.experimental",
"short" : "For testing purposes, not real usage",
"definition" : "A Boolean value to indicate that this research element definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.",
"comment" : "Allows filtering of research element definitions that are appropriate for use versus not.",
"requirements" : "Enables experimental content to be developed following the same lifecycle that would be used for a production-level research element definition.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ResearchElementDefinition.experimental",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.experimental"
},
{
"identity" : "w5",
"map" : "FiveWs.class"
}]
},
{
"id" : "ResearchElementDefinition.subject[x]",
"path" : "ResearchElementDefinition.subject[x]",
"short" : "E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device",
"definition" : "The intended subjects for the ResearchElementDefinition. If this element is not provided, a Patient subject is assumed, but the subject of the ResearchElementDefinition can be anything.",
"comment" : "The subject of the ResearchElementDefinition is critical in interpreting the criteria definitions, as the logic in the ResearchElementDefinitions is evaluated with respect to a particular subject. This corresponds roughly to the notion of a Compartment in that it limits what content is available based on its relationship to the subject. In CQL, this corresponds to the context declaration.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ResearchElementDefinition.subject[x]",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
},
{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Group"]
}],
"meaningWhenMissing" : "Patient",
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SubjectType"
}],
"strength" : "extensible",
"description" : "The possible types of subjects for a measure (E.g. Patient, Practitioner, Organization, Location, etc.).",
"valueSet" : "http://hl7.org/fhir/ValueSet/subject-type"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.subject"
}]
},
{
"id" : "ResearchElementDefinition.date",
"path" : "ResearchElementDefinition.date",
"short" : "Date last changed",
"definition" : "The date (and optionally time) when the research element definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the research element definition changes.",
"comment" : "Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the research element definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.",
"alias" : ["Revision Date"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "ResearchElementDefinition.date",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.date"
},
{
"identity" : "w5",
"map" : "FiveWs.recorded"
}]
},
{
"id" : "ResearchElementDefinition.publisher",
"path" : "ResearchElementDefinition.publisher",
"short" : "Name of the publisher (organization or individual)",
"definition" : "The name of the organization or individual that published the research element definition.",
"comment" : "Usually an organization but may be an individual. The publisher (or steward) of the research element definition is the organization or individual primarily responsible for the maintenance and upkeep of the research element definition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the research element definition. This item SHOULD be populated unless the information is available from context.",
"requirements" : "Helps establish the \"authority/credibility\" of the research element definition. May also allow for contact.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ResearchElementDefinition.publisher",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.publisher"
},
{
"identity" : "w5",
"map" : "FiveWs.witness"
}]
},
{
"id" : "ResearchElementDefinition.contact",
"path" : "ResearchElementDefinition.contact",
"short" : "Contact details for the publisher",
"definition" : "Contact details to assist a user in finding and communicating with the publisher.",
"comment" : "May be a web site, an email address, a telephone number, etc.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ResearchElementDefinition.contact",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "ContactDetail"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.contact"
}]
},
{
"id" : "ResearchElementDefinition.description",
"path" : "ResearchElementDefinition.description",
"short" : "Natural language description of the research element definition",
"definition" : "A free text natural language description of the research element definition from a consumer's perspective.",
"comment" : "This description can be used to capture details such as why the research element definition was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the research element definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the research element definition is presumed to be the predominant language in the place the research element definition was created).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ResearchElementDefinition.description",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "markdown"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.description"
}]
},
{
"id" : "ResearchElementDefinition.comment",
"path" : "ResearchElementDefinition.comment",
"short" : "Used for footnotes or explanatory notes",
"definition" : "A human-readable string to clarify or explain concepts about the resource.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ResearchElementDefinition.comment",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ResearchElementDefinition.useContext",
"path" : "ResearchElementDefinition.useContext",
"short" : "The context that the content is intended to support",
"definition" : "The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate research element definition instances.",
"comment" : "When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.",
"requirements" : "Assist in searching for appropriate content.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ResearchElementDefinition.useContext",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "UsageContext"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.useContext"
}]
},
{
"id" : "ResearchElementDefinition.jurisdiction",
"path" : "ResearchElementDefinition.jurisdiction",
"short" : "Intended jurisdiction for research element definition (if applicable)",
"definition" : "A legal or geographic region in which the research element definition is intended to be used.",
"comment" : "It may be possible for the research element definition to be used in jurisdictions other than those for which it was originally designed or intended.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ResearchElementDefinition.jurisdiction",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Jurisdiction"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "extensible",
"description" : "Countries and regions within which this artifact is targeted for use.",
"valueSet" : "http://hl7.org/fhir/ValueSet/jurisdiction"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.jurisdiction"
}]
},
{
"id" : "ResearchElementDefinition.purpose",
"path" : "ResearchElementDefinition.purpose",
"short" : "Why this research element definition is defined",
"definition" : "Explanation of why this research element definition is needed and why it has been designed as it has.",
"comment" : "This element does not describe the usage of the research element definition. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this research element definition.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ResearchElementDefinition.purpose",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "markdown"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.purpose"
},
{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "ResearchElementDefinition.usage",
"path" : "ResearchElementDefinition.usage",
"short" : "Describes the clinical usage of the ResearchElementDefinition",
"definition" : "A detailed description, from a clinical perspective, of how the ResearchElementDefinition is used.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ResearchElementDefinition.usage",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ResearchElementDefinition.copyright",
"path" : "ResearchElementDefinition.copyright",
"short" : "Use and/or publishing restrictions",
"definition" : "A copyright statement relating to the research element definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the research element definition.",
"requirements" : "Consumers must be able to determine any legal restrictions on the use of the research element definition and/or its content.",
"alias" : ["License",
"Restrictions"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "ResearchElementDefinition.copyright",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "markdown"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.copyright"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "ResearchElementDefinition.approvalDate",
"path" : "ResearchElementDefinition.approvalDate",
"short" : "When the research element definition was approved by publisher",
"definition" : "The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.",
"comment" : "The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ResearchElementDefinition.approvalDate",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "date"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.approvalDate"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "ResearchElementDefinition.lastReviewDate",
"path" : "ResearchElementDefinition.lastReviewDate",
"short" : "When the research element definition was last reviewed",
"definition" : "The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.",
"comment" : "If specified, this date follows the original approval date.",
"requirements" : "Gives a sense of how \"current\" the content is. Resources that have not been reviewed in a long time may have a risk of being less appropriate/relevant.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ResearchElementDefinition.lastReviewDate",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "date"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.lastReviewDate"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "ResearchElementDefinition.effectivePeriod",
"path" : "ResearchElementDefinition.effectivePeriod",
"short" : "When the research element definition is expected to be used",
"definition" : "The period during which the research element definition content was or is planned to be in active use.",
"comment" : "The effective period for a research element definition determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 might be published in 2015.",
"requirements" : "Allows establishing a transition before a resource comes into effect and also allows for a sunsetting process when new versions of the research element definition are or are expected to be used instead.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ResearchElementDefinition.effectivePeriod",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Period"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.effectivePeriod"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "ResearchElementDefinition.topic",
"path" : "ResearchElementDefinition.topic",
"short" : "The category of the ResearchElementDefinition, such as Education, Treatment, Assessment, etc.",
"definition" : "Descriptive topics related to the content of the ResearchElementDefinition. Topics provide a high-level categorization grouping types of ResearchElementDefinitions that can be useful for filtering and searching.",
"requirements" : "Repositories must be able to determine how to categorize the ResearchElementDefinition so that it can be found by topical searches.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ResearchElementDefinition.topic",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "DefinitionTopic"
}],
"strength" : "example",
"description" : "High-level categorization of the definition, used for searching, sorting, and filtering.",
"valueSet" : "http://hl7.org/fhir/ValueSet/definition-topic"
}
},
{
"id" : "ResearchElementDefinition.author",
"path" : "ResearchElementDefinition.author",
"short" : "Who authored the content",
"definition" : "An individiual or organization primarily involved in the creation and maintenance of the content.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ResearchElementDefinition.author",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "ContactDetail"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".participation[typeCode=AUT]"
}]
},
{
"id" : "ResearchElementDefinition.editor",
"path" : "ResearchElementDefinition.editor",
"short" : "Who edited the content",
"definition" : "An individual or organization primarily responsible for internal coherence of the content.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ResearchElementDefinition.editor",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "ContactDetail"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ResearchElementDefinition.reviewer",
"path" : "ResearchElementDefinition.reviewer",
"short" : "Who reviewed the content",
"definition" : "An individual or organization primarily responsible for review of some aspect of the content.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ResearchElementDefinition.reviewer",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "ContactDetail"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".participation[typeCode=VRF] {not clear whether VRF best corresponds to reviewer or endorser}"
}]
},
{
"id" : "ResearchElementDefinition.endorser",
"path" : "ResearchElementDefinition.endorser",
"short" : "Who endorsed the content",
"definition" : "An individual or organization responsible for officially endorsing the content for use in some setting.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ResearchElementDefinition.endorser",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "ContactDetail"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".participation[typeCode=VRF] {not clear whether VRF best corresponds to reviewer or endorser}"
}]
},
{
"id" : "ResearchElementDefinition.relatedArtifact",
"path" : "ResearchElementDefinition.relatedArtifact",
"short" : "Additional documentation, citations, etc.",
"definition" : "Related artifacts such as additional documentation, justification, or bibliographic references.",
"comment" : "Each related artifact is either an attachment, or a reference to another resource, but not both.",
"requirements" : "ResearchElementDefinitions must be able to provide enough information for consumers of the content (and/or interventions or results produced by the content) to be able to determine and understand the justification for and evidence in support of the content.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ResearchElementDefinition.relatedArtifact",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "RelatedArtifact"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ResearchElementDefinition.library",
"path" : "ResearchElementDefinition.library",
"short" : "Logic used by the ResearchElementDefinition",
"definition" : "A reference to a Library resource containing the formal logic used by the ResearchElementDefinition.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ResearchElementDefinition.library",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Library"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ResearchElementDefinition.type",
"path" : "ResearchElementDefinition.type",
"short" : "population | exposure | outcome",
"definition" : "The type of research element, a population, an exposure, or an outcome.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ResearchElementDefinition.type",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ResearchElementType"
}],
"strength" : "required",
"description" : "The possible types of research elements (E.g. Population, Exposure, Outcome).",
"valueSet" : "http://hl7.org/fhir/ValueSet/research-element-type|4.0.1"
}
},
{
"id" : "ResearchElementDefinition.variableType",
"path" : "ResearchElementDefinition.variableType",
"short" : "dichotomous | continuous | descriptive",
"definition" : "The type of the outcome (e.g. Dichotomous, Continuous, or Descriptive).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ResearchElementDefinition.variableType",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "VariableType"
}],
"strength" : "required",
"description" : "The possible types of variables for exposures or outcomes (E.g. Dichotomous, Continuous, Descriptive).",
"valueSet" : "http://hl7.org/fhir/ValueSet/variable-type|4.0.1"
}
},
{
"id" : "ResearchElementDefinition.characteristic",
"path" : "ResearchElementDefinition.characteristic",
"short" : "What defines the members of the research element",
"definition" : "A characteristic that defines the members of the research element. Multiple characteristics are applied with \"and\" semantics.",
"comment" : "Characteristics can be defined flexibly to accommodate different use cases for membership criteria, ranging from simple codes, all the way to using an expression language to express the criteria.",
"min" : 1,
"max" : "*",
"base" : {
"path" : "ResearchElementDefinition.characteristic",
"min" : 1,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "ResearchElementDefinition.characteristic.id",
"path" : "ResearchElementDefinition.characteristic.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "ResearchElementDefinition.characteristic.extension",
"path" : "ResearchElementDefinition.characteristic.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "ResearchElementDefinition.characteristic.modifierExtension",
"path" : "ResearchElementDefinition.characteristic.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ResearchElementDefinition.characteristic.definition[x]",
"path" : "ResearchElementDefinition.characteristic.definition[x]",
"short" : "What code or expression defines members?",
"definition" : "Define members of the research element using Codes (such as condition, medication, or observation), Expressions ( using an expression language such as FHIRPath or CQL) or DataRequirements (such as Diabetes diagnosis onset in the last year).",
"requirements" : "Need to be able to define members in simple codes when the membership aligns well with terminology, with common criteria such as observations in a value set or lab tests within a year, or with expression language to support criteria that do not fit in the above.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ResearchElementDefinition.characteristic.definition[x]",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
},
{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ValueSet"]
},
{
"code" : "Expression"
},
{
"code" : "DataRequirement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "ResearchElementDefinition.characteristic.usageContext",
"path" : "ResearchElementDefinition.characteristic.usageContext",
"short" : "What code/value pairs define members?",
"definition" : "Use UsageContext to define the members of the population, such as Age Ranges, Genders, Settings.",
"requirements" : "Need to be able to define members more structurally when more information can be communicated such as age range.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ResearchElementDefinition.characteristic.usageContext",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "UsageContext"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ResearchElementDefinition.characteristic.exclude",
"path" : "ResearchElementDefinition.characteristic.exclude",
"short" : "Whether the characteristic includes or excludes members",
"definition" : "When true, members with this characteristic are excluded from the element.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ResearchElementDefinition.characteristic.exclude",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"meaningWhenMissing" : "False",
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ResearchElementDefinition.characteristic.unitOfMeasure",
"path" : "ResearchElementDefinition.characteristic.unitOfMeasure",
"short" : "What unit is the outcome described in?",
"definition" : "Specifies the UCUM unit for the outcome.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ResearchElementDefinition.characteristic.unitOfMeasure",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "UCUMUnits"
}],
"strength" : "required",
"description" : "Unified Code for Units of Measure (UCUM).",
"valueSet" : "http://hl7.org/fhir/ValueSet/ucum-units|4.0.1"
}
},
{
"id" : "ResearchElementDefinition.characteristic.studyEffectiveDescription",
"path" : "ResearchElementDefinition.characteristic.studyEffectiveDescription",
"short" : "What time period does the study cover",
"definition" : "A narrative description of the time period the study covers.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ResearchElementDefinition.characteristic.studyEffectiveDescription",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ResearchElementDefinition.characteristic.studyEffective[x]",
"path" : "ResearchElementDefinition.characteristic.studyEffective[x]",
"short" : "What time period does the study cover",
"definition" : "Indicates what effective period the study covers.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ResearchElementDefinition.characteristic.studyEffective[x]",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
},
{
"code" : "Period"
},
{
"code" : "Duration"
},
{
"code" : "Timing"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ResearchElementDefinition.characteristic.studyEffectiveTimeFromStart",
"path" : "ResearchElementDefinition.characteristic.studyEffectiveTimeFromStart",
"short" : "Observation time from study start",
"definition" : "Indicates duration from the study initiation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ResearchElementDefinition.characteristic.studyEffectiveTimeFromStart",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Duration"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ResearchElementDefinition.characteristic.studyEffectiveGroupMeasure",
"path" : "ResearchElementDefinition.characteristic.studyEffectiveGroupMeasure",
"short" : "mean | median | mean-of-mean | mean-of-median | median-of-mean | median-of-median",
"definition" : "Indicates how elements are aggregated within the study effective period.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ResearchElementDefinition.characteristic.studyEffectiveGroupMeasure",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "GroupMeasure"
}],
"strength" : "required",
"description" : "Possible group measure aggregates (E.g. Mean, Median).",
"valueSet" : "http://hl7.org/fhir/ValueSet/group-measure|4.0.1"
}
},
{
"id" : "ResearchElementDefinition.characteristic.participantEffectiveDescription",
"path" : "ResearchElementDefinition.characteristic.participantEffectiveDescription",
"short" : "What time period do participants cover",
"definition" : "A narrative description of the time period the study covers.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ResearchElementDefinition.characteristic.participantEffectiveDescription",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ResearchElementDefinition.characteristic.participantEffective[x]",
"path" : "ResearchElementDefinition.characteristic.participantEffective[x]",
"short" : "What time period do participants cover",
"definition" : "Indicates what effective period the study covers.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ResearchElementDefinition.characteristic.participantEffective[x]",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
},
{
"code" : "Period"
},
{
"code" : "Duration"
},
{
"code" : "Timing"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ResearchElementDefinition.characteristic.participantEffectiveTimeFromStart",
"path" : "ResearchElementDefinition.characteristic.participantEffectiveTimeFromStart",
"short" : "Observation time from study start",
"definition" : "Indicates duration from the participant's study entry.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ResearchElementDefinition.characteristic.participantEffectiveTimeFromStart",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Duration"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ResearchElementDefinition.characteristic.participantEffectiveGroupMeasure",
"path" : "ResearchElementDefinition.characteristic.participantEffectiveGroupMeasure",
"short" : "mean | median | mean-of-mean | mean-of-median | median-of-mean | median-of-median",
"definition" : "Indicates how elements are aggregated within the study effective period.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ResearchElementDefinition.characteristic.participantEffectiveGroupMeasure",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "GroupMeasure"
}],
"strength" : "required",
"description" : "Possible group measure aggregates (E.g. Mean, Median).",
"valueSet" : "http://hl7.org/fhir/ValueSet/group-measure|4.0.1"
}
}]
},
"differential" : {
"element" : [{
"id" : "ResearchElementDefinition",
"path" : "ResearchElementDefinition",
"short" : "A population, intervention, or exposure definition",
"definition" : "The ResearchElementDefinition resource describes a \"PICO\" element that knowledge (evidence, assertion, recommendation) is about.",
"comment" : "PICO stands for Population (the population within which exposures are being compared), Intervention (the conditional state or exposure state being described for its effect on outcomes), Comparison (the alternative conditional state or alternative exposure state being compared against), and Outcome (the result or effect of the intervention in the population).",
"min" : 0,
"max" : "*",
"constraint" : [{
"key" : "red-0",
"severity" : "warning",
"human" : "Name should be usable as an identifier for the module by machine processing applications such as code generation",
"expression" : "name.matches('[A-Z]([A-Za-z0-9_]){0,254}')",
"xpath" : "not(exists(f:name/@value)) or matches(f:name/@value, '[A-Z]([A-Za-z0-9_]){0,254}')"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Definition"
}]
},
{
"id" : "ResearchElementDefinition.url",
"path" : "ResearchElementDefinition.url",
"short" : "Canonical identifier for this research element definition, represented as a URI (globally unique)",
"definition" : "An absolute URI that is used to identify this research element definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this research element definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the research element definition is stored on different servers.",
"comment" : "Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.\n\nThe determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions). \n\nIn some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.",
"requirements" : "Allows the research element definition to be referenced by a single globally unique identifier.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "uri"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.url"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
}]
},
{
"id" : "ResearchElementDefinition.identifier",
"path" : "ResearchElementDefinition.identifier",
"short" : "Additional identifier for the research element definition",
"definition" : "A formal identifier that is used to identify this research element definition when it is represented in other formats, or referenced in a specification, model, design or an instance.",
"comment" : "Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this research element definition outside of FHIR, where it is not possible to use the logical URI.",
"requirements" : "Allows externally provided and/or usable business identifiers to be easily associated with the module.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Identifier"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.identifier"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "ResearchElementDefinition.version",
"path" : "ResearchElementDefinition.version",
"short" : "Business version of the research element definition",
"definition" : "The identifier that is used to identify this version of the research element definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the research element definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts.",
"comment" : "There may be different research element definition instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the research element definition with the format [url]|[version].",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.version"
},
{
"identity" : "w5",
"map" : "FiveWs.version"
}]
},
{
"id" : "ResearchElementDefinition.name",
"path" : "ResearchElementDefinition.name",
"short" : "Name for this research element definition (computer friendly)",
"definition" : "A natural language name identifying the research element definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.",
"comment" : "The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.",
"requirements" : "Support human navigation and code generation.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"condition" : ["inv-0"],
"isSummary" : true
},
{
"id" : "ResearchElementDefinition.title",
"path" : "ResearchElementDefinition.title",
"short" : "Name for this research element definition (human friendly)",
"definition" : "A short, descriptive, user-friendly title for the research element definition.",
"comment" : "This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.title"
}]
},
{
"id" : "ResearchElementDefinition.shortTitle",
"path" : "ResearchElementDefinition.shortTitle",
"short" : "Title for use in informal contexts",
"definition" : "The short title provides an alternate title for use in informal descriptive contexts where the full, formal title is not necessary.",
"requirements" : "Need to be able to reference the content by a short description, but still provide a longer, more formal title for the content.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "ResearchElementDefinition.subtitle",
"path" : "ResearchElementDefinition.subtitle",
"short" : "Subordinate title of the ResearchElementDefinition",
"definition" : "An explanatory or alternate title for the ResearchElementDefinition giving additional information about its content.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}]
},
{
"id" : "ResearchElementDefinition.status",
"path" : "ResearchElementDefinition.status",
"short" : "draft | active | retired | unknown",
"definition" : "The status of this research element definition. Enables tracking the life-cycle of the content.",
"comment" : "Allows filtering of research element definitions that are appropriate for use versus not.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isModifier" : true,
"isModifierReason" : "This is labeled as \"Is Modifier\" because applications should not use a retired {{title}} without due consideration",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "PublicationStatus"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "The lifecycle status of an artifact.",
"valueSet" : "http://hl7.org/fhir/ValueSet/publication-status|4.0.1"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.status"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
}]
},
{
"id" : "ResearchElementDefinition.experimental",
"path" : "ResearchElementDefinition.experimental",
"short" : "For testing purposes, not real usage",
"definition" : "A Boolean value to indicate that this research element definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.",
"comment" : "Allows filtering of research element definitions that are appropriate for use versus not.",
"requirements" : "Enables experimental content to be developed following the same lifecycle that would be used for a production-level research element definition.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "boolean"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.experimental"
},
{
"identity" : "w5",
"map" : "FiveWs.class"
}]
},
{
"id" : "ResearchElementDefinition.subject[x]",
"path" : "ResearchElementDefinition.subject[x]",
"short" : "E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device",
"definition" : "The intended subjects for the ResearchElementDefinition. If this element is not provided, a Patient subject is assumed, but the subject of the ResearchElementDefinition can be anything.",
"comment" : "The subject of the ResearchElementDefinition is critical in interpreting the criteria definitions, as the logic in the ResearchElementDefinitions is evaluated with respect to a particular subject. This corresponds roughly to the notion of a Compartment in that it limits what content is available based on its relationship to the subject. In CQL, this corresponds to the context declaration.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
},
{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Group"]
}],
"meaningWhenMissing" : "Patient",
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SubjectType"
}],
"strength" : "extensible",
"description" : "The possible types of subjects for a measure (E.g. Patient, Practitioner, Organization, Location, etc.).",
"valueSet" : "http://hl7.org/fhir/ValueSet/subject-type"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.subject"
}]
},
{
"id" : "ResearchElementDefinition.date",
"path" : "ResearchElementDefinition.date",
"short" : "Date last changed",
"definition" : "The date (and optionally time) when the research element definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the research element definition changes.",
"comment" : "Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the research element definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.",
"alias" : ["Revision Date"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "dateTime"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.date"
},
{
"identity" : "w5",
"map" : "FiveWs.recorded"
}]
},
{
"id" : "ResearchElementDefinition.publisher",
"path" : "ResearchElementDefinition.publisher",
"short" : "Name of the publisher (organization or individual)",
"definition" : "The name of the organization or individual that published the research element definition.",
"comment" : "Usually an organization but may be an individual. The publisher (or steward) of the research element definition is the organization or individual primarily responsible for the maintenance and upkeep of the research element definition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the research element definition. This item SHOULD be populated unless the information is available from context.",
"requirements" : "Helps establish the \"authority/credibility\" of the research element definition. May also allow for contact.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.publisher"
},
{
"identity" : "w5",
"map" : "FiveWs.witness"
}]
},
{
"id" : "ResearchElementDefinition.contact",
"path" : "ResearchElementDefinition.contact",
"short" : "Contact details for the publisher",
"definition" : "Contact details to assist a user in finding and communicating with the publisher.",
"comment" : "May be a web site, an email address, a telephone number, etc.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "ContactDetail"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.contact"
}]
},
{
"id" : "ResearchElementDefinition.description",
"path" : "ResearchElementDefinition.description",
"short" : "Natural language description of the research element definition",
"definition" : "A free text natural language description of the research element definition from a consumer's perspective.",
"comment" : "This description can be used to capture details such as why the research element definition was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the research element definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the research element definition is presumed to be the predominant language in the place the research element definition was created).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "markdown"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.description"
}]
},
{
"id" : "ResearchElementDefinition.comment",
"path" : "ResearchElementDefinition.comment",
"short" : "Used for footnotes or explanatory notes",
"definition" : "A human-readable string to clarify or explain concepts about the resource.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "string"
}]
},
{
"id" : "ResearchElementDefinition.useContext",
"path" : "ResearchElementDefinition.useContext",
"short" : "The context that the content is intended to support",
"definition" : "The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate research element definition instances.",
"comment" : "When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.",
"requirements" : "Assist in searching for appropriate content.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "UsageContext"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.useContext"
}]
},
{
"id" : "ResearchElementDefinition.jurisdiction",
"path" : "ResearchElementDefinition.jurisdiction",
"short" : "Intended jurisdiction for research element definition (if applicable)",
"definition" : "A legal or geographic region in which the research element definition is intended to be used.",
"comment" : "It may be possible for the research element definition to be used in jurisdictions other than those for which it was originally designed or intended.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Jurisdiction"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "extensible",
"description" : "Countries and regions within which this artifact is targeted for use.",
"valueSet" : "http://hl7.org/fhir/ValueSet/jurisdiction"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.jurisdiction"
}]
},
{
"id" : "ResearchElementDefinition.purpose",
"path" : "ResearchElementDefinition.purpose",
"short" : "Why this research element definition is defined",
"definition" : "Explanation of why this research element definition is needed and why it has been designed as it has.",
"comment" : "This element does not describe the usage of the research element definition. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this research element definition.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "markdown"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.purpose"
},
{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "ResearchElementDefinition.usage",
"path" : "ResearchElementDefinition.usage",
"short" : "Describes the clinical usage of the ResearchElementDefinition",
"definition" : "A detailed description, from a clinical perspective, of how the ResearchElementDefinition is used.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}]
},
{
"id" : "ResearchElementDefinition.copyright",
"path" : "ResearchElementDefinition.copyright",
"short" : "Use and/or publishing restrictions",
"definition" : "A copyright statement relating to the research element definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the research element definition.",
"requirements" : "Consumers must be able to determine any legal restrictions on the use of the research element definition and/or its content.",
"alias" : ["License",
"Restrictions"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "markdown"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.copyright"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "ResearchElementDefinition.approvalDate",
"path" : "ResearchElementDefinition.approvalDate",
"short" : "When the research element definition was approved by publisher",
"definition" : "The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.",
"comment" : "The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "date"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.approvalDate"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "ResearchElementDefinition.lastReviewDate",
"path" : "ResearchElementDefinition.lastReviewDate",
"short" : "When the research element definition was last reviewed",
"definition" : "The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.",
"comment" : "If specified, this date follows the original approval date.",
"requirements" : "Gives a sense of how \"current\" the content is. Resources that have not been reviewed in a long time may have a risk of being less appropriate/relevant.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "date"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.lastReviewDate"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "ResearchElementDefinition.effectivePeriod",
"path" : "ResearchElementDefinition.effectivePeriod",
"short" : "When the research element definition is expected to be used",
"definition" : "The period during which the research element definition content was or is planned to be in active use.",
"comment" : "The effective period for a research element definition determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 might be published in 2015.",
"requirements" : "Allows establishing a transition before a resource comes into effect and also allows for a sunsetting process when new versions of the research element definition are or are expected to be used instead.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Period"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.effectivePeriod"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "ResearchElementDefinition.topic",
"path" : "ResearchElementDefinition.topic",
"short" : "The category of the ResearchElementDefinition, such as Education, Treatment, Assessment, etc.",
"definition" : "Descriptive topics related to the content of the ResearchElementDefinition. Topics provide a high-level categorization grouping types of ResearchElementDefinitions that can be useful for filtering and searching.",
"requirements" : "Repositories must be able to determine how to categorize the ResearchElementDefinition so that it can be found by topical searches.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "DefinitionTopic"
}],
"strength" : "example",
"description" : "High-level categorization of the definition, used for searching, sorting, and filtering.",
"valueSet" : "http://hl7.org/fhir/ValueSet/definition-topic"
}
},
{
"id" : "ResearchElementDefinition.author",
"path" : "ResearchElementDefinition.author",
"short" : "Who authored the content",
"definition" : "An individiual or organization primarily involved in the creation and maintenance of the content.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "ContactDetail"
}],
"mapping" : [{
"identity" : "rim",
"map" : ".participation[typeCode=AUT]"
}]
},
{
"id" : "ResearchElementDefinition.editor",
"path" : "ResearchElementDefinition.editor",
"short" : "Who edited the content",
"definition" : "An individual or organization primarily responsible for internal coherence of the content.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "ContactDetail"
}]
},
{
"id" : "ResearchElementDefinition.reviewer",
"path" : "ResearchElementDefinition.reviewer",
"short" : "Who reviewed the content",
"definition" : "An individual or organization primarily responsible for review of some aspect of the content.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "ContactDetail"
}],
"mapping" : [{
"identity" : "rim",
"map" : ".participation[typeCode=VRF] {not clear whether VRF best corresponds to reviewer or endorser}"
}]
},
{
"id" : "ResearchElementDefinition.endorser",
"path" : "ResearchElementDefinition.endorser",
"short" : "Who endorsed the content",
"definition" : "An individual or organization responsible for officially endorsing the content for use in some setting.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "ContactDetail"
}],
"mapping" : [{
"identity" : "rim",
"map" : ".participation[typeCode=VRF] {not clear whether VRF best corresponds to reviewer or endorser}"
}]
},
{
"id" : "ResearchElementDefinition.relatedArtifact",
"path" : "ResearchElementDefinition.relatedArtifact",
"short" : "Additional documentation, citations, etc.",
"definition" : "Related artifacts such as additional documentation, justification, or bibliographic references.",
"comment" : "Each related artifact is either an attachment, or a reference to another resource, but not both.",
"requirements" : "ResearchElementDefinitions must be able to provide enough information for consumers of the content (and/or interventions or results produced by the content) to be able to determine and understand the justification for and evidence in support of the content.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "RelatedArtifact"
}]
},
{
"id" : "ResearchElementDefinition.library",
"path" : "ResearchElementDefinition.library",
"short" : "Logic used by the ResearchElementDefinition",
"definition" : "A reference to a Library resource containing the formal logic used by the ResearchElementDefinition.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Library"]
}]
},
{
"id" : "ResearchElementDefinition.type",
"path" : "ResearchElementDefinition.type",
"short" : "population | exposure | outcome",
"definition" : "The type of research element, a population, an exposure, or an outcome.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ResearchElementType"
}],
"strength" : "required",
"description" : "The possible types of research elements (E.g. Population, Exposure, Outcome).",
"valueSet" : "http://hl7.org/fhir/ValueSet/research-element-type|4.0.1"
}
},
{
"id" : "ResearchElementDefinition.variableType",
"path" : "ResearchElementDefinition.variableType",
"short" : "dichotomous | continuous | descriptive",
"definition" : "The type of the outcome (e.g. Dichotomous, Continuous, or Descriptive).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "code"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "VariableType"
}],
"strength" : "required",
"description" : "The possible types of variables for exposures or outcomes (E.g. Dichotomous, Continuous, Descriptive).",
"valueSet" : "http://hl7.org/fhir/ValueSet/variable-type|4.0.1"
}
},
{
"id" : "ResearchElementDefinition.characteristic",
"path" : "ResearchElementDefinition.characteristic",
"short" : "What defines the members of the research element",
"definition" : "A characteristic that defines the members of the research element. Multiple characteristics are applied with \"and\" semantics.",
"comment" : "Characteristics can be defined flexibly to accommodate different use cases for membership criteria, ranging from simple codes, all the way to using an expression language to express the criteria.",
"min" : 1,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"isSummary" : true
},
{
"id" : "ResearchElementDefinition.characteristic.definition[x]",
"path" : "ResearchElementDefinition.characteristic.definition[x]",
"short" : "What code or expression defines members?",
"definition" : "Define members of the research element using Codes (such as condition, medication, or observation), Expressions ( using an expression language such as FHIRPath or CQL) or DataRequirements (such as Diabetes diagnosis onset in the last year).",
"requirements" : "Need to be able to define members in simple codes when the membership aligns well with terminology, with common criteria such as observations in a value set or lab tests within a year, or with expression language to support criteria that do not fit in the above.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
},
{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ValueSet"]
},
{
"code" : "Expression"
},
{
"code" : "DataRequirement"
}],
"isSummary" : true
},
{
"id" : "ResearchElementDefinition.characteristic.usageContext",
"path" : "ResearchElementDefinition.characteristic.usageContext",
"short" : "What code/value pairs define members?",
"definition" : "Use UsageContext to define the members of the population, such as Age Ranges, Genders, Settings.",
"requirements" : "Need to be able to define members more structurally when more information can be communicated such as age range.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "UsageContext"
}]
},
{
"id" : "ResearchElementDefinition.characteristic.exclude",
"path" : "ResearchElementDefinition.characteristic.exclude",
"short" : "Whether the characteristic includes or excludes members",
"definition" : "When true, members with this characteristic are excluded from the element.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "boolean"
}],
"meaningWhenMissing" : "False"
},
{
"id" : "ResearchElementDefinition.characteristic.unitOfMeasure",
"path" : "ResearchElementDefinition.characteristic.unitOfMeasure",
"short" : "What unit is the outcome described in?",
"definition" : "Specifies the UCUM unit for the outcome.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "UCUMUnits"
}],
"strength" : "required",
"description" : "Unified Code for Units of Measure (UCUM).",
"valueSet" : "http://hl7.org/fhir/ValueSet/ucum-units|4.0.1"
}
},
{
"id" : "ResearchElementDefinition.characteristic.studyEffectiveDescription",
"path" : "ResearchElementDefinition.characteristic.studyEffectiveDescription",
"short" : "What time period does the study cover",
"definition" : "A narrative description of the time period the study covers.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}]
},
{
"id" : "ResearchElementDefinition.characteristic.studyEffective[x]",
"path" : "ResearchElementDefinition.characteristic.studyEffective[x]",
"short" : "What time period does the study cover",
"definition" : "Indicates what effective period the study covers.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "dateTime"
},
{
"code" : "Period"
},
{
"code" : "Duration"
},
{
"code" : "Timing"
}]
},
{
"id" : "ResearchElementDefinition.characteristic.studyEffectiveTimeFromStart",
"path" : "ResearchElementDefinition.characteristic.studyEffectiveTimeFromStart",
"short" : "Observation time from study start",
"definition" : "Indicates duration from the study initiation.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Duration"
}]
},
{
"id" : "ResearchElementDefinition.characteristic.studyEffectiveGroupMeasure",
"path" : "ResearchElementDefinition.characteristic.studyEffectiveGroupMeasure",
"short" : "mean | median | mean-of-mean | mean-of-median | median-of-mean | median-of-median",
"definition" : "Indicates how elements are aggregated within the study effective period.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "code"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "GroupMeasure"
}],
"strength" : "required",
"description" : "Possible group measure aggregates (E.g. Mean, Median).",
"valueSet" : "http://hl7.org/fhir/ValueSet/group-measure|4.0.1"
}
},
{
"id" : "ResearchElementDefinition.characteristic.participantEffectiveDescription",
"path" : "ResearchElementDefinition.characteristic.participantEffectiveDescription",
"short" : "What time period do participants cover",
"definition" : "A narrative description of the time period the study covers.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}]
},
{
"id" : "ResearchElementDefinition.characteristic.participantEffective[x]",
"path" : "ResearchElementDefinition.characteristic.participantEffective[x]",
"short" : "What time period do participants cover",
"definition" : "Indicates what effective period the study covers.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "dateTime"
},
{
"code" : "Period"
},
{
"code" : "Duration"
},
{
"code" : "Timing"
}]
},
{
"id" : "ResearchElementDefinition.characteristic.participantEffectiveTimeFromStart",
"path" : "ResearchElementDefinition.characteristic.participantEffectiveTimeFromStart",
"short" : "Observation time from study start",
"definition" : "Indicates duration from the participant's study entry.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Duration"
}]
},
{
"id" : "ResearchElementDefinition.characteristic.participantEffectiveGroupMeasure",
"path" : "ResearchElementDefinition.characteristic.participantEffectiveGroupMeasure",
"short" : "mean | median | mean-of-mean | mean-of-median | median-of-mean | median-of-median",
"definition" : "Indicates how elements are aggregated within the study effective period.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "code"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "GroupMeasure"
}],
"strength" : "required",
"description" : "Possible group measure aggregates (E.g. Mean, Median).",
"valueSet" : "http://hl7.org/fhir/ValueSet/group-measure|4.0.1"
}
}]
}
}
},
{
"fullUrl" : "http://hl7.org/fhir/StructureDefinition/ResearchStudy",
"resource" : {
"resourceType" : "StructureDefinition",
"id" : "ResearchStudy",
"meta" : {
"lastUpdated" : "2019-11-01T09:29:23.356+11:00"
},
"text" : {
"status" : "generated",
"div" : "Name Flags Card. Type Description & Constraints ResearchStudy TU DomainResource Investigation to increase healthcare-related patient-independent knowledge
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension identifier Σ 0..* Identifier Business Identifier for study
title Σ 0..1 string Name for this study protocol Σ 0..* Reference(PlanDefinition) Steps followed in executing study
partOf Σ 0..* Reference(ResearchStudy) Part of larger study
status ?!Σ 1..1 code active | administratively-completed | approved | closed-to-accrual | closed-to-accrual-and-intervention | completed | disapproved | in-review | temporarily-closed-to-accrual | temporarily-closed-to-accrual-and-intervention | withdrawn
ResearchStudyStatus (Required) primaryPurposeType Σ 0..1 CodeableConcept treatment | prevention | diagnostic | supportive-care | screening | health-services-research | basic-science | device-feasibility
ResearchStudyPrimaryPurposeType (Extensible) phase Σ 0..1 CodeableConcept n-a | early-phase-1 | phase-1 | phase-1-phase-2 | phase-2 | phase-2-phase-3 | phase-3 | phase-4
ResearchStudyPhase (Example) category Σ 0..* CodeableConcept Classifications for the study
focus Σ 0..* CodeableConcept Drugs, devices, etc. under study
condition Σ 0..* CodeableConcept Condition being studied
Condition/Problem/Diagnosis Codes (Example)
contact Σ 0..* ContactDetail Contact details for the study
relatedArtifact 0..* RelatedArtifact References and dependencies
keyword Σ 0..* CodeableConcept Used to search for the study
location Σ 0..* CodeableConcept Geographic region(s) for study
Jurisdiction (Extensible)
description 0..1 markdown What this is study doing enrollment Σ 0..* Reference(Group) Inclusion & exclusion criteria
period Σ 0..1 Period When the study began and ended sponsor Σ 0..1 Reference(Organization) Organization that initiates and is legally responsible for the study principalInvestigator Σ 0..1 Reference(Practitioner | PractitionerRole) Researcher who oversees multiple aspects of the study site Σ 0..* Reference(Location) Facility where study activities are conducted
reasonStopped Σ 0..1 CodeableConcept accrual-goal-met | closed-due-to-toxicity | closed-due-to-lack-of-study-progress | temporarily-closed-per-study-design
ResearchStudyReasonStopped (Example) note 0..* Annotation Comments made about the study
arm 0..* BackboneElement Defined path through the study for a subject
name 1..1 string Label for study arm type 0..1 CodeableConcept Categorization of study arm description 0..1 string Short explanation of study path objective 0..* BackboneElement A goal for the study
name 0..1 string Label for the objective type 0..1 CodeableConcept primary | secondary | exploratory
ResearchStudyObjectiveType (Preferred)
Documentation for this format
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Specialized.Public Health & Research"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 1
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "business"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "brr"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/ResearchStudy",
"version" : "4.0.1",
"name" : "ResearchStudy",
"status" : "draft",
"date" : "2019-11-01T09:29:23+11:00",
"publisher" : "Health Level Seven International (Biomedical Research and Regulation)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/rcrim/index.cfm"
}]
}],
"description" : "A process where a researcher or organization plans and then executes a series of steps intended to increase the field of healthcare-related knowledge. This includes studies of safety, efficacy, comparative effectiveness and other information about medications, devices, therapies and other interventional and investigative techniques. A ResearchStudy involves the gathering of information about human or animal subjects.",
"fhirVersion" : "4.0.1",
"mapping" : [{
"identity" : "BRIDG5.1",
"uri" : "https://bridgmodel.nci.nih.gov",
"name" : "BRIDG 5.1 Mapping"
},
{
"identity" : "v2",
"uri" : "http://hl7.org/v2",
"name" : "HL7 v2 Mapping"
},
{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
},
{
"identity" : "clinicaltrials-gov",
"uri" : "http://clinicaltrials.gov",
"name" : "ClinicalTrials.gov Mapping"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/fivews",
"name" : "FiveWs Pattern Mapping"
}],
"kind" : "resource",
"abstract" : false,
"type" : "ResearchStudy",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "ResearchStudy",
"path" : "ResearchStudy",
"short" : "Investigation to increase healthcare-related patient-independent knowledge",
"definition" : "A process where a researcher or organization plans and then executes a series of steps intended to increase the field of healthcare-related knowledge. This includes studies of safety, efficacy, comparative effectiveness and other information about medications, devices, therapies and other interventional and investigative techniques. A ResearchStudy involves the gathering of information about human or animal subjects.",
"comment" : "Need to make sure we encompass public health studies.",
"alias" : ["Clinical Trial",
"Study"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "ResearchStudy",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "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",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.`div`.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "BRIDG5.1",
"map" : "ObservationalStudyProtocolVersion; Study;\nStudyProtocolVersion"
},
{
"identity" : "v2",
"map" : "OBX"
},
{
"identity" : "rim",
"map" : "Observation[classCode=CLNTRL, moodCode=EVN]"
}]
},
{
"id" : "ResearchStudy.id",
"path" : "ResearchStudy.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "ResearchStudy.meta",
"path" : "ResearchStudy.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "ResearchStudy.implicitRules",
"path" : "ResearchStudy.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "ResearchStudy.language",
"path" : "ResearchStudy.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "ResearchStudy.text",
"path" : "ResearchStudy.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "ResearchStudy.contained",
"path" : "ResearchStudy.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ResearchStudy.extension",
"path" : "ResearchStudy.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ResearchStudy.modifierExtension",
"path" : "ResearchStudy.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ResearchStudy.identifier",
"path" : "ResearchStudy.identifier",
"short" : "Business Identifier for study",
"definition" : "Identifiers assigned to this research study by the sponsor or other systems.",
"requirements" : "Allows identification of the research study as it is known by various participating systems and in a way that remains consistent across servers.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ResearchStudy.identifier",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Identifier"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "clinicaltrials-gov",
"map" : "Organization's Unique Protocol ID; Secondary IDs"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "BRIDG5.1",
"map" : "No BRIDG mapping (although there is DocumentVersion.identifier > StudyProtocolDocumentVersion, this is arguably a different semantic)"
},
{
"identity" : "rim",
"map" : ".identifier"
}]
},
{
"id" : "ResearchStudy.name",
"path" : "ResearchStudy.name",
"short" : "Name for this study (computer friendly)",
"definition" : "Name for this study (computer friendly).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ResearchStudy.name",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ResearchStudy.title",
"path" : "ResearchStudy.title",
"short" : "Human readable name of the study",
"definition" : "The human readable name of the research study.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ResearchStudy.title",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "clinicaltrials-gov",
"map" : "Brief Title"
},
{
"identity" : "BRIDG5.1",
"map" : "No BRIDG mapping (although there is StudyProtocolDocumentVersionPublicTitle this is arguably a different semantic: title of a document vs title of a research study)"
}]
},
{
"id" : "ResearchStudy.label",
"path" : "ResearchStudy.label",
"short" : "Additional names for the study",
"definition" : "Additional names for the study.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ResearchStudy.label",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ResearchStudy.label.id",
"path" : "ResearchStudy.label.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"condition" : ["ele-1"],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "ResearchStudy.label.extension",
"path" : "ResearchStudy.label.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "ResearchStudy.label.modifierExtension",
"path" : "ResearchStudy.label.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ResearchStudy.label.type",
"path" : "ResearchStudy.label.type",
"short" : "primary | official | scientific | plain-language | subtitle | short-title | acronym | earlier-title | language | auto-translated | human-use | machine-use | duplicate-uid",
"definition" : "Kind of name.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ResearchStudy.label.type",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "TitleType"
}],
"strength" : "extensible",
"description" : "desc.",
"valueSet" : "http://hl7.org/fhir/ValueSet/title-type"
}
},
{
"id" : "ResearchStudy.label.value",
"path" : "ResearchStudy.label.value",
"short" : "The name",
"definition" : "The name.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ResearchStudy.label.value",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ResearchStudy.protocol",
"path" : "ResearchStudy.protocol",
"short" : "Steps followed in executing study",
"definition" : "The set of steps expected to be performed as part of the execution of the study.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ResearchStudy.protocol",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/PlanDefinition"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "clinicaltrials-gov",
"map" : "Interventions; Arm/Intervention Cross-Reference"
},
{
"identity" : "BRIDG5.1",
"map" : "StudyProtocolDocumentVersionPublicTitle.name"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=DEFN].target"
}]
},
{
"id" : "ResearchStudy.partOf",
"path" : "ResearchStudy.partOf",
"short" : "Part of larger study",
"definition" : "A larger research study of which this particular study is a component or step.",
"requirements" : "Allows breaking a study into components (e.g. by study site) each with their own PI, status, enrollment, etc.",
"alias" : ["container"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "ResearchStudy.partOf",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ResearchStudy"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "BRIDG5.1",
"map" : "CompanionStudyRelationship"
},
{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=COMP].source[moodCode=EVN]"
}]
},
{
"id" : "ResearchStudy.status",
"path" : "ResearchStudy.status",
"short" : "active | administratively-completed | approved | closed-to-accrual | closed-to-accrual-and-intervention | completed | disapproved | in-review | temporarily-closed-to-accrual | temporarily-closed-to-accrual-and-intervention | withdrawn",
"definition" : "The current state of the study.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ResearchStudy.status",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ResearchStudyStatus"
}],
"strength" : "required",
"description" : "Codes that convey the current status of the research study.",
"valueSet" : "http://hl7.org/fhir/ValueSet/research-study-status|4.0.1"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.status"
},
{
"identity" : "BRIDG5.1",
"map" : "StudyOverallStatus.code"
},
{
"identity" : "rim",
"map" : ".status"
}]
},
{
"id" : "ResearchStudy.primaryPurposeType",
"path" : "ResearchStudy.primaryPurposeType",
"short" : "treatment | prevention | diagnostic | supportive-care | screening | health-services-research | basic-science | device-feasibility",
"definition" : "The type of study based upon the intent of the study's activities. A classification of the intent of the study.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ResearchStudy.primaryPurposeType",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ResearchStudyPrimaryPurposeType"
}],
"strength" : "extensible",
"description" : "Codes for the main intent of the study.",
"valueSet" : "http://hl7.org/fhir/ValueSet/research-study-prim-purp-type"
},
"mapping" : [{
"identity" : "BRIDG5.1",
"map" : "StudyProtocolVersion.primaryPurposeTypeCode"
}]
},
{
"id" : "ResearchStudy.phase",
"path" : "ResearchStudy.phase",
"short" : "n-a | early-phase-1 | phase-1 | phase-1-phase-2 | phase-2 | phase-2-phase-3 | phase-3 | phase-4",
"definition" : "The stage in the progression of a therapy from initial experimental use in humans in clinical trials to post-market evaluation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ResearchStudy.phase",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ResearchStudyPhase"
}],
"strength" : "example",
"description" : "Codes for the stage in the progression of a therapy from initial experimental use in humans in clinical trials to post-market evaluation.",
"valueSet" : "http://hl7.org/fhir/ValueSet/research-study-phase"
},
"mapping" : [{
"identity" : "clinicaltrials-gov",
"map" : "Study Phase"
},
{
"identity" : "BRIDG5.1",
"map" : "StudyProtocolVersion.phaseCode"
}]
},
{
"id" : "ResearchStudy.studyDesign",
"path" : "ResearchStudy.studyDesign",
"short" : "Classifications of the study design characteristics",
"definition" : "Codes categorizing the type of study such as investigational vs. observational, type of blinding, type of randomization, safety vs. efficacy, etc.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ResearchStudy.studyDesign",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "StudyDesign"
}],
"strength" : "preferred",
"description" : "This is a set of terms for study design characteristics.",
"valueSet" : "http://hl7.org/fhir/ValueSet/study-design"
},
"mapping" : [{
"identity" : "clinicaltrials-gov",
"map" : "Study Type; Primary Purpose; Interventional Model; Masking; Allocation; study Classification; Observational Study Model; Time Perspective; Biospecimen Retention"
},
{
"identity" : "BRIDG5.1",
"map" : "InterventionalStudyProtocolVersion; InterventionalStudyProtocol.allocationCode; InterventionalStudyProtocol.blindedRoleCode; InterventionalStudyProtocol.blindingSchemaCode; InterventionalStudyProtocol.controlTypeCode"
}]
},
{
"id" : "ResearchStudy.category",
"path" : "ResearchStudy.category",
"short" : "Classifications for the study",
"definition" : "Codes categorizing the type of study such as investigational vs. observational, type of blinding, type of randomization, safety vs. efficacy, etc.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ResearchStudy.category",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ResearchStudyCategory"
}],
"strength" : "example",
"description" : "Codes that describe the type of research study. E.g. Study phase, Interventional/Observational, blinding type, etc."
},
"mapping" : [{
"identity" : "clinicaltrials-gov",
"map" : "Study Type; Primary Purpose; Interventional Model; Masking; Allocation; study Classification; Observational Study Model; Time Perspective; Biospecimen Retention"
},
{
"identity" : "BRIDG5.1",
"map" : "InterventionalStudyProtocolVersion; InterventionalStudyProtocol.allocationCode; InterventionalStudyProtocol.blindedRoleCode; InterventionalStudyProtocol.blindingSchemaCode; InterventionalStudyProtocol.controlTypeCode"
}]
},
{
"id" : "ResearchStudy.focus",
"path" : "ResearchStudy.focus",
"short" : "Drugs, devices, etc. under study",
"definition" : "The medication(s), food(s), therapy(ies), device(s) or other concerns or interventions that the study is seeking to gain more information about.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ResearchStudy.focus",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ResearchStudyFocus"
}],
"strength" : "example",
"description" : "Codes for medications, devices and other interventions."
},
"mapping" : [{
"identity" : "clinicaltrials-gov",
"map" : "Focus of Study"
},
{
"identity" : "w5",
"map" : "FiveWs.what[x]"
},
{
"identity" : "BRIDG5.1",
"map" : "InterventionalStudyProtocol.interventionTypeCode"
}]
},
{
"id" : "ResearchStudy.condition",
"path" : "ResearchStudy.condition",
"short" : "Condition being studied",
"definition" : "The condition that is the focus of the study. For example, In a study to examine risk factors for Lupus, might have as an inclusion criterion \"healthy volunteer\", but the target condition code would be a Lupus SNOMED code.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ResearchStudy.condition",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ConditionCode"
}],
"strength" : "example",
"description" : "Identification of the condition or diagnosis.",
"valueSet" : "http://hl7.org/fhir/ValueSet/condition-code"
},
"mapping" : [{
"identity" : "clinicaltrials-gov",
"map" : "Conditions"
},
{
"identity" : "w5",
"map" : "FiveWs.what[x]"
},
{
"identity" : "BRIDG5.1",
"map" : "StudyCondition.code"
}]
},
{
"id" : "ResearchStudy.contact",
"path" : "ResearchStudy.contact",
"short" : "Contact details for the study",
"definition" : "Contact details to assist a user in learning more about or engaging with the study.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ResearchStudy.contact",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "ContactDetail"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "clinicaltrials-gov",
"map" : "Central Contact; Central Contact Backup; Overall Study Officials; Facility Contact & Backup (if Study tied to only one location); Investigators"
},
{
"identity" : "BRIDG5.1",
"map" : "PointOfContact > Project > Research Project > Study > StudyProtocol > StudyProtocolVersion"
}]
},
{
"id" : "ResearchStudy.relatedArtifact",
"path" : "ResearchStudy.relatedArtifact",
"short" : "References, URLs, and attachments",
"definition" : "Citations, references, URLs and other related documents. When using relatedArtifact to share URLs, the relatedArtifact.type will often be set to one of \"documentation\" or \"supported-with\" and the URL value will often be in relatedArtifact.document.url but another possible location is relatedArtifact.resource when it is a canonical URL.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ResearchStudy.relatedArtifact",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "RelatedArtifact"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "clinicaltrials-gov",
"map" : "Citations, Links, Available Study Data/Documents"
},
{
"identity" : "BRIDG5.1",
"map" : "StudyProtocolDocument, StudyProtocolDocumentVersion"
}]
},
{
"id" : "ResearchStudy.keyword",
"path" : "ResearchStudy.keyword",
"short" : "Used to search for the study",
"definition" : "Key terms to aid in searching for or filtering the study.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ResearchStudy.keyword",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ResearchStudyKeyword"
}],
"strength" : "example",
"description" : "Words associated with the study that may be useful in discovery."
},
"mapping" : [{
"identity" : "clinicaltrials-gov",
"map" : "Keywords"
},
{
"identity" : "BRIDG5.1",
"map" : "DocumentVersion.keywordCode; DocumentVersion.keywordText"
}]
},
{
"id" : "ResearchStudy.location",
"path" : "ResearchStudy.location",
"short" : "Geographic region(s) for study",
"definition" : "Indicates a country, state or other region where the study is taking place.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ResearchStudy.location",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Jurisdiction"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "extensible",
"description" : "Countries and regions within which this artifact is targeted for use.",
"valueSet" : "http://hl7.org/fhir/ValueSet/jurisdiction"
},
"mapping" : [{
"identity" : "BRIDG5.1",
"map" : "StudyProtocolVersion.participatingLocationCode"
}]
},
{
"id" : "ResearchStudy.region",
"path" : "ResearchStudy.region",
"short" : "Geographic area for the study",
"definition" : "A country, state or other area where the study is taking place rather than its precise geographic location or address.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ResearchStudy.region",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Jurisdiction"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "extensible",
"description" : "Countries and regions within which this artifact is targeted for use.",
"valueSet" : "http://hl7.org/fhir/ValueSet/jurisdiction"
},
"mapping" : [{
"identity" : "BRIDG5.1",
"map" : "StudyProtocolVersion.participatingLocationCode"
}]
},
{
"id" : "ResearchStudy.descriptionSummary",
"path" : "ResearchStudy.descriptionSummary",
"short" : "Brief text explaining the study",
"definition" : "A brief text for explaining the study.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ResearchStudy.descriptionSummary",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "markdown"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ResearchStudy.description",
"path" : "ResearchStudy.description",
"short" : "Detailed narrative of the study",
"definition" : "A detailed and human-readable narrative of the study. E.g., study abstract.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ResearchStudy.description",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "markdown"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "clinicaltrials-gov",
"map" : "Detailed Description"
},
{
"identity" : "BRIDG5.1",
"map" : "StudyProtocolDocumentVersion.publicDescription"
}]
},
{
"id" : "ResearchStudy.enrollment",
"path" : "ResearchStudy.enrollment",
"short" : "Inclusion & exclusion criteria",
"definition" : "Reference to a Group that defines the criteria for and quantity of subjects participating in the study. E.g. \" 200 female Europeans between the ages of 20 and 45 with early onset diabetes\".",
"comment" : "The Group referenced should not generally enumerate specific subjects. Subjects will be linked to the study using the ResearchSubject resource.",
"alias" : ["patient"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "ResearchStudy.enrollment",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Group"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "clinicaltrials-gov",
"map" : "Enrollment; Number of Groups/Cohorts (= number of \"enrollment\" instances); Groups (Group/Cohort Label = Group.name; Group/Cohort Description = Group.description); Eligibility (Group criteria)"
},
{
"identity" : "w5",
"map" : "FiveWs.subject[x]"
},
{
"identity" : "BRIDG5.1",
"map" : "InterventionalStudyProtocol.interventionGroupQuantity"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=SBJ].role"
},
{
"identity" : "w5",
"map" : "FiveWs.subject"
}]
},
{
"id" : "ResearchStudy.period",
"path" : "ResearchStudy.period",
"short" : "When the study began and ended",
"definition" : "Identifies the start date and the expected (or actual, depending on status) end date for the study.",
"alias" : ["timing"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "ResearchStudy.period",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Period"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "clinicaltrials-gov",
"map" : "Study Start Date (start); Study Completion Date (end)"
},
{
"identity" : "w5",
"map" : "FiveWs.done[x]"
},
{
"identity" : "BRIDG5.1",
"map" : "ProjectConduct.dateRange; StudyProtocolVersion.plannedDuration"
},
{
"identity" : "rim",
"map" : ".effectiveTime"
}]
},
{
"id" : "ResearchStudy.sponsor",
"path" : "ResearchStudy.sponsor",
"short" : "Organization that initiates and is legally responsible for the study",
"definition" : "An organization that initiates the investigation and is legally responsible for the study.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ResearchStudy.sponsor",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "clinicaltrials-gov",
"map" : "Sponsor"
},
{
"identity" : "w5",
"map" : "FiveWs.actor"
},
{
"identity" : "BRIDG5.1",
"map" : "RegulatoryApplicationSponsor; StudyLegalSponsor; StudyProtocolVersion.responsiblePartyCode"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]"
}]
},
{
"id" : "ResearchStudy.principalInvestigator",
"path" : "ResearchStudy.principalInvestigator",
"short" : "Researcher who oversees multiple aspects of the study",
"definition" : "A researcher in a study who oversees multiple aspects of the study, such as concept development, protocol writing, protocol submission for IRB approval, participant recruitment, informed consent, data collection, analysis, interpretation and presentation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ResearchStudy.principalInvestigator",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "clinicaltrials-gov",
"map" : "Principal Investigator"
},
{
"identity" : "w5",
"map" : "FiveWs.actor"
},
{
"identity" : "BRIDG5.1",
"map" : "StudyInvestigator"
}]
},
{
"id" : "ResearchStudy.site",
"path" : "ResearchStudy.site",
"short" : "Facility where study activities are conducted",
"definition" : "A facility in which study activities are conducted.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ResearchStudy.site",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Location",
"http://hl7.org/fhir/StructureDefinition/ResearchStudy",
"http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "clinicaltrials-gov",
"map" : "Facility"
},
{
"identity" : "w5",
"map" : "FiveWs.where[x]"
},
{
"identity" : "BRIDG5.1",
"map" : "PlannedStudySite; StudySite"
}]
},
{
"id" : "ResearchStudy.reasonStopped",
"path" : "ResearchStudy.reasonStopped",
"short" : "accrual-goal-met | closed-due-to-toxicity | closed-due-to-lack-of-study-progress | temporarily-closed-per-study-design",
"definition" : "A description and/or code explaining the premature termination of the study.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ResearchStudy.reasonStopped",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ResearchStudyReasonStopped"
}],
"strength" : "example",
"description" : "Codes for why the study ended prematurely.",
"valueSet" : "http://hl7.org/fhir/ValueSet/research-study-reason-stopped"
},
"mapping" : [{
"identity" : "clinicaltrials-gov",
"map" : "Why Study Stopped"
},
{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "BRIDG5.1",
"map" : "StudyOverallStatus.studyStoppedReasonCode"
}]
},
{
"id" : "ResearchStudy.note",
"path" : "ResearchStudy.note",
"short" : "Comments made about the study",
"definition" : "Comments made about the study by the performer, subject or other participants.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ResearchStudy.note",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Annotation"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "BRIDG5.1",
"map" : "No BRIDG mapping"
},
{
"identity" : "rim",
"map" : ".inboundRelationship(typeCode=SUBJ].source[classCode=ANNGEN, moodCode=EVN].value[xsi:type=ST]"
}]
},
{
"id" : "ResearchStudy.arm",
"path" : "ResearchStudy.arm",
"short" : "Defined path through the study for a subject",
"definition" : "Describes an expected sequence of events for one of the participants of a study. E.g. Exposure to drug A, wash-out, exposure to drug B, wash-out, follow-up.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ResearchStudy.arm",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "clinicaltrials-gov",
"map" : "Arms"
},
{
"identity" : "BRIDG5.1",
"map" : "Arm"
}]
},
{
"id" : "ResearchStudy.arm.id",
"path" : "ResearchStudy.arm.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "ResearchStudy.arm.extension",
"path" : "ResearchStudy.arm.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "ResearchStudy.arm.modifierExtension",
"path" : "ResearchStudy.arm.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ResearchStudy.arm.name",
"path" : "ResearchStudy.arm.name",
"short" : "Label for study arm",
"definition" : "Unique, human-readable label for this arm of the study.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ResearchStudy.arm.name",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "clinicaltrials-gov",
"map" : "Arm Label"
},
{
"identity" : "BRIDG5.1",
"map" : "Arm.name"
}]
},
{
"id" : "ResearchStudy.arm.type",
"path" : "ResearchStudy.arm.type",
"short" : "Categorization of study arm",
"definition" : "Categorization of study arm, e.g. experimental, active comparator, placebo comparater.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ResearchStudy.arm.type",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "clinicaltrials-gov",
"map" : "Arm Type"
},
{
"identity" : "BRIDG5.1",
"map" : "Arm.typeCode"
}]
},
{
"id" : "ResearchStudy.arm.description",
"path" : "ResearchStudy.arm.description",
"short" : "Short explanation of study path",
"definition" : "A succinct description of the path through the study that would be followed by a subject adhering to this arm.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ResearchStudy.arm.description",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "clinicaltrials-gov",
"map" : "Arm Description"
},
{
"identity" : "BRIDG5.1",
"map" : "Arm.description"
}]
},
{
"id" : "ResearchStudy.classifier",
"path" : "ResearchStudy.classifier",
"short" : "Classification for the study",
"definition" : "Additional grouping mechanism or categorization of a research study. Example: FDA regulated device, FDA regulated drug, MPG Paragraph 23b (a German legal requirement), IRB-exempt, etc. Implementation Note: do not use the classifier element to support existing semantics that are already supported thru explicit elements in the resource.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ResearchStudy.classifier",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ResearchStudyClassifiers"
}],
"strength" : "example",
"description" : "desc.",
"valueSet" : "http://hl7.org/fhir/ValueSet/research-study-classifiers"
}
},
{
"id" : "ResearchStudy.associatedParty",
"path" : "ResearchStudy.associatedParty",
"short" : "Sponsors, collaborators, and other parties",
"definition" : "Sponsors, collaborators, and other parties.",
"comment" : "For a Sponsor or a PrincipalInvestigator use the dedicated attributes provided.",
"requirements" : "While there are explicit attributes for a Sponsor and a PrincipalInvestigator many trial record a range of other organizations and individuals in key roles.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ResearchStudy.associatedParty",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ResearchStudy.associatedParty.id",
"path" : "ResearchStudy.associatedParty.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"condition" : ["ele-1"],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "ResearchStudy.associatedParty.extension",
"path" : "ResearchStudy.associatedParty.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "ResearchStudy.associatedParty.modifierExtension",
"path" : "ResearchStudy.associatedParty.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ResearchStudy.associatedParty.name",
"path" : "ResearchStudy.associatedParty.name",
"short" : "Name of associated party",
"definition" : "Name of associated party.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ResearchStudy.associatedParty.name",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ResearchStudy.associatedParty.role",
"path" : "ResearchStudy.associatedParty.role",
"short" : "sponsor | lead-sponsor | sponsor-investigator | primary-investigator | collaborator | funding-source | general-contact | recruitment-contact | sub-investigator | study-director | study-chair",
"definition" : "Type of association.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ResearchStudy.associatedParty.role",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ResearchStudyPartyRole"
}],
"strength" : "extensible",
"description" : "desc.",
"valueSet" : "http://hl7.org/fhir/ValueSet/research-study-party-role"
}
},
{
"id" : "ResearchStudy.associatedParty.period",
"path" : "ResearchStudy.associatedParty.period",
"short" : "When active in the role",
"definition" : "Identifies the start date and the end date of the associated party in the role.",
"comment" : "The cardinality is 0..* due to the fact that an associated party may be intermittently active in a given role over multiple time periods.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ResearchStudy.associatedParty.period",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Period"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ResearchStudy.associatedParty.classifier",
"path" : "ResearchStudy.associatedParty.classifier",
"short" : "nih | fda | government | nonprofit | academic | industry",
"definition" : "A categorization other than role for the associated party.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ResearchStudy.associatedParty.classifier",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ResearchStudyPartyOrganizationType"
}],
"strength" : "example",
"description" : "A characterization or type of the entity.",
"valueSet" : "http://hl7.org/fhir/ValueSet/research-study-party-organization-type"
}
},
{
"id" : "ResearchStudy.associatedParty.party",
"path" : "ResearchStudy.associatedParty.party",
"short" : "Individual or organization associated with study (use practitionerRole to specify their organisation)",
"definition" : "Individual or organization associated with study (use practitionerRole to specify their organisation).",
"comment" : "Suggestions of a better attribute name are appreciated",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ResearchStudy.associatedParty.party",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ResearchStudy.progressStatus",
"path" : "ResearchStudy.progressStatus",
"short" : "Status of study with time for that status",
"definition" : "Status of study with time for that status.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ResearchStudy.progressStatus",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ResearchStudy.progressStatus.id",
"path" : "ResearchStudy.progressStatus.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"condition" : ["ele-1"],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "ResearchStudy.progressStatus.extension",
"path" : "ResearchStudy.progressStatus.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "ResearchStudy.progressStatus.modifierExtension",
"path" : "ResearchStudy.progressStatus.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ResearchStudy.progressStatus.state",
"path" : "ResearchStudy.progressStatus.state",
"short" : "Label for status or state (e.g. recruitment status)",
"definition" : "Label for status or state (e.g. recruitment status).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ResearchStudy.progressStatus.state",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ResearchStudyStudyStatus"
}],
"strength" : "extensible",
"description" : "defn.",
"valueSet" : "http://hl7.org/fhir/ValueSet/research-study-status"
}
},
{
"id" : "ResearchStudy.progressStatus.actual",
"path" : "ResearchStudy.progressStatus.actual",
"short" : "Actual if true else anticipated",
"definition" : "An indication of whether or not the date is a known date when the state changed or will change. A value of true indicates a known date. A value of false indicates an estimated date.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ResearchStudy.progressStatus.actual",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ResearchStudy.progressStatus.period",
"path" : "ResearchStudy.progressStatus.period",
"short" : "Date range",
"definition" : "Date range.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ResearchStudy.progressStatus.period",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Period"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ResearchStudy.whyStopped",
"path" : "ResearchStudy.whyStopped",
"short" : "accrual-goal-met | closed-due-to-toxicity | closed-due-to-lack-of-study-progress | temporarily-closed-per-study-design",
"definition" : "A description and/or code explaining the premature termination of the study.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ResearchStudy.whyStopped",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ResearchStudyReasonStopped"
}],
"strength" : "example",
"description" : "Codes for why the study ended prematurely.",
"valueSet" : "http://hl7.org/fhir/ValueSet/research-study-reason-stopped"
},
"mapping" : [{
"identity" : "clinicaltrials-gov",
"map" : "Why Study Stopped"
},
{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "BRIDG5.1",
"map" : "StudyOverallStatus.studyStoppedReasonCode"
}]
},
{
"id" : "ResearchStudy.recruitment",
"path" : "ResearchStudy.recruitment",
"short" : "Target or actual group of participants enrolled in study",
"definition" : "Target or actual group of participants enrolled in study.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ResearchStudy.recruitment",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "clinicaltrials-gov",
"map" : "Enrollment; Number of Groups/Cohorts (= number of \"enrollment\" instances); Groups (Group/Cohort Label = Group.name; Group/Cohort Description = Group.description); Eligibility (Group criteria)"
},
{
"identity" : "w5",
"map" : "FiveWs.subject[x]"
},
{
"identity" : "BRIDG5.1",
"map" : "InterventionalStudyProtocol.interventionGroupQuantity"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=SBJ].role"
}]
},
{
"id" : "ResearchStudy.recruitment.id",
"path" : "ResearchStudy.recruitment.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"condition" : ["ele-1"],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "ResearchStudy.recruitment.extension",
"path" : "ResearchStudy.recruitment.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "ResearchStudy.recruitment.modifierExtension",
"path" : "ResearchStudy.recruitment.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ResearchStudy.recruitment.targetNumber",
"path" : "ResearchStudy.recruitment.targetNumber",
"short" : "Estimated total number of participants to be enrolled",
"definition" : "Estimated total number of participants to be enrolled.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ResearchStudy.recruitment.targetNumber",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "unsignedInt"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ResearchStudy.recruitment.actualNumber",
"path" : "ResearchStudy.recruitment.actualNumber",
"short" : "Actual total number of participants enrolled in study",
"definition" : "Actual total number of participants enrolled in study.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ResearchStudy.recruitment.actualNumber",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "unsignedInt"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ResearchStudy.recruitment.eligibility",
"path" : "ResearchStudy.recruitment.eligibility",
"short" : "Inclusion and exclusion criteria",
"definition" : "Inclusion and exclusion criteria.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ResearchStudy.recruitment.eligibility",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Group",
"http://hl7.org/fhir/StructureDefinition/EvidenceVariable"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ResearchStudy.recruitment.actualGroup",
"path" : "ResearchStudy.recruitment.actualGroup",
"short" : "Group of participants who were enrolled in study",
"definition" : "Group of participants who were enrolled in study.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ResearchStudy.recruitment.actualGroup",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Group"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "clinicaltrials-gov",
"map" : "Enrollment; Number of Groups/Cohorts (= number of \"enrollment\" instances); Groups (Group/Cohort Label = Group.name; Group/Cohort Description = Group.description); Eligibility (Group criteria)"
},
{
"identity" : "w5",
"map" : "FiveWs.subject[x]"
},
{
"identity" : "BRIDG5.1",
"map" : "InterventionalStudyProtocol.interventionGroupQuantity"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=SBJ].role"
}]
},
{
"id" : "ResearchStudy.comparisonGroup",
"path" : "ResearchStudy.comparisonGroup",
"short" : "Defined path through the study for a subject",
"definition" : "Describes an expected event or sequence of events for one of the subjects of a study. E.g. for a living subject: exposure to drug A, wash-out, exposure to drug B, wash-out, follow-up. E.g. for a stability study: {store sample from lot A at 25 degrees for 1 month}, {store sample from lot A at 40 degrees for 1 month}.",
"comment" : "In many clinical trials this is refered to as the ARM of the study, but such a term is not used in other sorts of trials even when there is a comparison between two or more groups.",
"alias" : ["arm"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "ResearchStudy.comparisonGroup",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "clinicaltrials-gov",
"map" : "Arms"
},
{
"identity" : "BRIDG5.1",
"map" : "Arm"
}]
},
{
"id" : "ResearchStudy.comparisonGroup.id",
"path" : "ResearchStudy.comparisonGroup.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"condition" : ["ele-1"],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "ResearchStudy.comparisonGroup.extension",
"path" : "ResearchStudy.comparisonGroup.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "ResearchStudy.comparisonGroup.modifierExtension",
"path" : "ResearchStudy.comparisonGroup.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ResearchStudy.comparisonGroup.linkId",
"path" : "ResearchStudy.comparisonGroup.linkId",
"short" : "Allows the comparisonGroup for the study and the comparisonGroup for the subject to be linked easily",
"definition" : "Allows the comparisonGroup for the study and the comparisonGroup for the subject to be linked easily.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ResearchStudy.comparisonGroup.linkId",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "id"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ResearchStudy.comparisonGroup.name",
"path" : "ResearchStudy.comparisonGroup.name",
"short" : "Label for study comparisonGroup",
"definition" : "Unique, human-readable label for this comparisonGroup of the study.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ResearchStudy.comparisonGroup.name",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "clinicaltrials-gov",
"map" : "Arm Label"
},
{
"identity" : "BRIDG5.1",
"map" : "Arm.name"
}]
},
{
"id" : "ResearchStudy.comparisonGroup.type",
"path" : "ResearchStudy.comparisonGroup.type",
"short" : "Categorization of study comparisonGroup",
"definition" : "Categorization of study comparisonGroup, e.g. experimental, active comparator, placebo comparater.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ResearchStudy.comparisonGroup.type",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ResearchStudyArmType"
}],
"strength" : "extensible",
"description" : "desc.",
"valueSet" : "http://hl7.org/fhir/ValueSet/research-study-arm-type"
},
"mapping" : [{
"identity" : "clinicaltrials-gov",
"map" : "Arm Type"
},
{
"identity" : "BRIDG5.1",
"map" : "Arm.typeCode"
}]
},
{
"id" : "ResearchStudy.comparisonGroup.description",
"path" : "ResearchStudy.comparisonGroup.description",
"short" : "Short explanation of study path",
"definition" : "A succinct description of the path through the study that would be followed by a subject adhering to this comparisonGroup.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ResearchStudy.comparisonGroup.description",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "markdown"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "clinicaltrials-gov",
"map" : "Arm Description"
},
{
"identity" : "BRIDG5.1",
"map" : "Arm.description"
}]
},
{
"id" : "ResearchStudy.comparisonGroup.intendedExposure",
"path" : "ResearchStudy.comparisonGroup.intendedExposure",
"short" : "Interventions or exposures in this comparisonGroup or cohort",
"definition" : "Interventions or exposures in this comparisonGroup or cohort.",
"requirements" : "this is necessary for ClinicalTrials.gov use which relates 1 to many interventions to comparisonGroups (aka arms)",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ResearchStudy.comparisonGroup.intendedExposure",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/EvidenceVariable"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ResearchStudy.comparisonGroup.observedGroup",
"path" : "ResearchStudy.comparisonGroup.observedGroup",
"short" : "Group of participants who were enrolled in study comparisonGroup",
"definition" : "Group of participants who were enrolled in study comparisonGroup.",
"requirements" : "This is necessary to relate comparisonGroups to actual groups",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ResearchStudy.comparisonGroup.observedGroup",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Group"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ResearchStudy.objective",
"path" : "ResearchStudy.objective",
"short" : "A goal for the study",
"definition" : "A goal that the study is aiming to achieve in terms of a scientific question to be answered by the analysis of data collected during the study.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ResearchStudy.objective",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "BRIDG5.1",
"map" : "StudyObjective"
}]
},
{
"id" : "ResearchStudy.objective.id",
"path" : "ResearchStudy.objective.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"condition" : ["ele-1"],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "ResearchStudy.objective.extension",
"path" : "ResearchStudy.objective.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "ResearchStudy.objective.modifierExtension",
"path" : "ResearchStudy.objective.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ResearchStudy.objective.name",
"path" : "ResearchStudy.objective.name",
"short" : "Label for the objective",
"definition" : "Unique, human-readable label for this objective of the study.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ResearchStudy.objective.name",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "BRIDG5.1",
"map" : "No BRIDG mapping (BRIDG has a description, but not a name)"
}]
},
{
"id" : "ResearchStudy.objective.type",
"path" : "ResearchStudy.objective.type",
"short" : "primary | secondary | exploratory",
"definition" : "The kind of study objective.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ResearchStudy.objective.type",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ResearchStudyObjectiveType"
}],
"strength" : "preferred",
"description" : "Codes for the kind of study objective.",
"valueSet" : "http://hl7.org/fhir/ValueSet/research-study-objective-type"
},
"mapping" : [{
"identity" : "BRIDG5.1",
"map" : "StudyObjective.typeCode"
}]
},
{
"id" : "ResearchStudy.objective.description",
"path" : "ResearchStudy.objective.description",
"short" : "Description of the objective",
"definition" : "Free text description of the objective of the study. This is what the study is trying to achieve rather than how it is going to achieve it (see ResearchStudy.description).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ResearchStudy.objective.description",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "markdown"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ResearchStudy.outcomeMeasure",
"path" : "ResearchStudy.outcomeMeasure",
"short" : "A variable measured during the study",
"definition" : "An \"outcome measure\", \"endpoint\", \"effect measure\" or \"measure of effect\" is a specific measurement or observation used to quantify the effect of experimental variables on the participants in a study, or for observational studies, to describe patterns of diseases or traits or associations with exposures, risk factors or treatment.",
"comment" : "A study may have multiple distinct outcome measures that can be used to assess the overall goal for a study. The goal of a study is in the objective whereas the metric by which the goal is assessed is the outcomeMeasure. Examples: Time to Local Recurrence (TLR), Disease-free Survival (DFS), 30 Day Mortality, Systolic BP",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ResearchStudy.outcomeMeasure",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ResearchStudy.outcomeMeasure.id",
"path" : "ResearchStudy.outcomeMeasure.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"condition" : ["ele-1"],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "ResearchStudy.outcomeMeasure.extension",
"path" : "ResearchStudy.outcomeMeasure.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "ResearchStudy.outcomeMeasure.modifierExtension",
"path" : "ResearchStudy.outcomeMeasure.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ResearchStudy.outcomeMeasure.name",
"path" : "ResearchStudy.outcomeMeasure.name",
"short" : "Label for the outcome",
"definition" : "Label for the outcome.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ResearchStudy.outcomeMeasure.name",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ResearchStudy.outcomeMeasure.type",
"path" : "ResearchStudy.outcomeMeasure.type",
"short" : "primary | secondary | exploratory",
"definition" : "The parameter or characteristic being assessed as one of the values by which the study is assessed.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ResearchStudy.outcomeMeasure.type",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ResearchStudyObjectiveType"
}],
"strength" : "preferred",
"description" : "defn.",
"valueSet" : "http://hl7.org/fhir/ValueSet/research-study-objective-type"
}
},
{
"id" : "ResearchStudy.outcomeMeasure.description",
"path" : "ResearchStudy.outcomeMeasure.description",
"short" : "Description of the outcome",
"definition" : "Description of the outcome.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ResearchStudy.outcomeMeasure.description",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "markdown"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ResearchStudy.outcomeMeasure.reference",
"path" : "ResearchStudy.outcomeMeasure.reference",
"short" : "Structured outcome definition",
"definition" : "Structured outcome definition.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ResearchStudy.outcomeMeasure.reference",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/EvidenceVariable"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ResearchStudy.result",
"path" : "ResearchStudy.result",
"short" : "Link to results generated during the study",
"definition" : "Link to one or more sets of results generated by the study. Could also link to a research registry holding the results such as ClinicalTrials.gov.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ResearchStudy.result",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/DiagnosticReport"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true
}]
},
"differential" : {
"element" : [{
"id" : "ResearchStudy",
"path" : "ResearchStudy",
"short" : "Investigation to increase healthcare-related patient-independent knowledge",
"definition" : "A process where a researcher or organization plans and then executes a series of steps intended to increase the field of healthcare-related knowledge. This includes studies of safety, efficacy, comparative effectiveness and other information about medications, devices, therapies and other interventional and investigative techniques. A ResearchStudy involves the gathering of information about human or animal subjects.",
"comment" : "Need to make sure we encompass public health studies.",
"alias" : ["Clinical Trial",
"Study"],
"min" : 0,
"max" : "*",
"mapping" : [{
"identity" : "BRIDG5.1",
"map" : "ObservationalStudyProtocolVersion; Study;\nStudyProtocolVersion"
},
{
"identity" : "v2",
"map" : "OBX"
},
{
"identity" : "rim",
"map" : "Observation[classCode=CLNTRL, moodCode=EVN]"
}]
},
{
"id" : "ResearchStudy.identifier",
"path" : "ResearchStudy.identifier",
"short" : "Business Identifier for study",
"definition" : "Identifiers assigned to this research study by the sponsor or other systems.",
"requirements" : "Allows identification of the research study as it is known by various participating systems and in a way that remains consistent across servers.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Identifier"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "clinicaltrials-gov",
"map" : "Organization's Unique Protocol ID; Secondary IDs"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "BRIDG5.1",
"map" : "No BRIDG mapping (although there is DocumentVersion.identifier > StudyProtocolDocumentVersion, this is arguably a different semantic)"
},
{
"identity" : "rim",
"map" : ".identifier"
}]
},
{
"id" : "ResearchStudy.title",
"path" : "ResearchStudy.title",
"short" : "Name for this study",
"definition" : "A short, descriptive user-friendly label for the study.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "clinicaltrials-gov",
"map" : "Brief Title"
},
{
"identity" : "BRIDG5.1",
"map" : "No BRIDG mapping (although there is StudyProtocolDocumentVersionPublicTitle this is arguably a different semantic: title of a document vs title of a research study)"
}]
},
{
"id" : "ResearchStudy.protocol",
"path" : "ResearchStudy.protocol",
"short" : "Steps followed in executing study",
"definition" : "The set of steps expected to be performed as part of the execution of the study.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/PlanDefinition"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "clinicaltrials-gov",
"map" : "Interventions; Arm/Intervention Cross-Reference"
},
{
"identity" : "BRIDG5.1",
"map" : "StudyProtocolDocumentVersionPublicTitle.name"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=DEFN].target"
}]
},
{
"id" : "ResearchStudy.partOf",
"path" : "ResearchStudy.partOf",
"short" : "Part of larger study",
"definition" : "A larger research study of which this particular study is a component or step.",
"requirements" : "Allows breaking a study into components (e.g. by study site) each with their own PI, status, enrollment, etc.",
"alias" : ["container"],
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ResearchStudy"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "BRIDG5.1",
"map" : "CompanionStudyRelationship"
},
{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=COMP].source[moodCode=EVN]"
}]
},
{
"id" : "ResearchStudy.status",
"path" : "ResearchStudy.status",
"short" : "draft | active | retired | unknown",
"definition" : "The publication state of the resource (not of the study).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ResearchStudy.status",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "PublicationStatus"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "Codes that convey the current publication status of the research study resource.",
"valueSet" : "http://hl7.org/fhir/ValueSet/publication-status|5.0.0"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.status"
},
{
"identity" : "BRIDG5.1",
"map" : "StudyOverallStatus.code"
},
{
"identity" : "rim",
"map" : ".status"
}]
},
{
"id" : "ResearchStudy.primaryPurposeType",
"path" : "ResearchStudy.primaryPurposeType",
"short" : "treatment | prevention | diagnostic | supportive-care | screening | health-services-research | basic-science | device-feasibility",
"definition" : "The type of study based upon the intent of the study activities. A classification of the intent of the study.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ResearchStudy.primaryPurposeType",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ResearchStudyPrimaryPurposeType"
}],
"strength" : "preferred",
"description" : "Codes for the main intent of the study.",
"valueSet" : "http://hl7.org/fhir/ValueSet/research-study-prim-purp-type"
},
"mapping" : [{
"identity" : "BRIDG5.1",
"map" : "StudyProtocolVersion.primaryPurposeTypeCode"
}]
},
{
"id" : "ResearchStudy.phase",
"path" : "ResearchStudy.phase",
"short" : "n-a | early-phase-1 | phase-1 | phase-1-phase-2 | phase-2 | phase-2-phase-3 | phase-3 | phase-4",
"definition" : "The stage in the progression of a therapy from initial experimental use in humans in clinical trials to post-market evaluation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ResearchStudy.phase",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ResearchStudyPhase"
}],
"strength" : "example",
"description" : "Codes for the stage in the progression of a therapy from initial experimental use in humans in clinical trials to post-market evaluation.",
"valueSet" : "http://hl7.org/fhir/ValueSet/research-study-phase"
},
"mapping" : [{
"identity" : "clinicaltrials-gov",
"map" : "Study Phase"
},
{
"identity" : "BRIDG5.1",
"map" : "StudyProtocolVersion.phaseCode"
}]
},
{
"id" : "ResearchStudy.studyDesign",
"path" : "ResearchStudy.studyDesign",
"short" : "Classifications of the study design characteristics",
"definition" : "Codes categorizing the type of study such as investigational vs. observational, type of blinding, type of randomization, safety vs. efficacy, etc.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ResearchStudy.studyDesign",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "StudyDesign"
}],
"strength" : "preferred",
"description" : "This is a set of terms for study design characteristics.",
"valueSet" : "http://hl7.org/fhir/ValueSet/study-design"
},
"mapping" : [{
"identity" : "clinicaltrials-gov",
"map" : "Study Type; Primary Purpose; Interventional Model; Masking; Allocation; study Classification; Observational Study Model; Time Perspective; Biospecimen Retention"
},
{
"identity" : "BRIDG5.1",
"map" : "InterventionalStudyProtocolVersion; InterventionalStudyProtocol.allocationCode; InterventionalStudyProtocol.blindedRoleCode; InterventionalStudyProtocol.blindingSchemaCode; InterventionalStudyProtocol.controlTypeCode"
}]
},
{
"id" : "ResearchStudy.category",
"path" : "ResearchStudy.category",
"short" : "Classifications for the study",
"definition" : "Codes categorizing the type of study such as investigational vs. observational, type of blinding, type of randomization, safety vs. efficacy, etc.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ResearchStudyCategory"
}],
"strength" : "example",
"description" : "Codes that describe the type of research study. E.g. Study phase, Interventional/Observational, blinding type, etc."
},
"mapping" : [{
"identity" : "clinicaltrials-gov",
"map" : "Study Type; Primary Purpose; Interventional Model; Masking; Allocation; study Classification; Observational Study Model; Time Perspective; Biospecimen Retention"
},
{
"identity" : "BRIDG5.1",
"map" : "InterventionalStudyProtocolVersion; InterventionalStudyProtocol.allocationCode; InterventionalStudyProtocol.blindedRoleCode; InterventionalStudyProtocol.blindingSchemaCode; InterventionalStudyProtocol.controlTypeCode"
}]
},
{
"id" : "ResearchStudy.focus",
"path" : "ResearchStudy.focus",
"short" : "Drugs, devices, etc. under study",
"definition" : "The medication(s), food(s), therapy(ies), device(s) or other concerns or interventions that the study is seeking to gain more information about.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ResearchStudyFocus"
}],
"strength" : "example",
"description" : "Codes for medications, devices and other interventions."
},
"mapping" : [{
"identity" : "clinicaltrials-gov",
"map" : "Focus of Study"
},
{
"identity" : "w5",
"map" : "FiveWs.what[x]"
},
{
"identity" : "BRIDG5.1",
"map" : "InterventionalStudyProtocol.interventionTypeCode"
}]
},
{
"id" : "ResearchStudy.condition",
"path" : "ResearchStudy.condition",
"short" : "Condition being studied",
"definition" : "The condition that is the focus of the study. For example, In a study to examine risk factors for Lupus, might have as an inclusion criterion \"healthy volunteer\", but the target condition code would be a Lupus SNOMED code.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ConditionCode"
}],
"strength" : "example",
"description" : "Identification of the condition or diagnosis.",
"valueSet" : "http://hl7.org/fhir/ValueSet/condition-code"
},
"mapping" : [{
"identity" : "clinicaltrials-gov",
"map" : "Conditions"
},
{
"identity" : "w5",
"map" : "FiveWs.what[x]"
},
{
"identity" : "BRIDG5.1",
"map" : "StudyCondition.code"
}]
},
{
"id" : "ResearchStudy.contact",
"path" : "ResearchStudy.contact",
"short" : "Contact details for the study",
"definition" : "Contact details to assist a user in learning more about or engaging with the study.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "ContactDetail"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "clinicaltrials-gov",
"map" : "Central Contact; Central Contact Backup; Overall Study Officials; Facility Contact & Backup (if Study tied to only one location); Investigators"
},
{
"identity" : "BRIDG5.1",
"map" : "PointOfContact > Project > Research Project > Study > StudyProtocol > StudyProtocolVersion"
}]
},
{
"id" : "ResearchStudy.relatedArtifact",
"path" : "ResearchStudy.relatedArtifact",
"short" : "References, URLs, and attachments",
"definition" : "Citations, references, URLs and other related documents. When using relatedArtifact to share URLs, the relatedArtifact.type will often be set to one of \"documentation\" or \"supported-with\" and the URL value will often be in relatedArtifact.document.url but another possible location is relatedArtifact.resource when it is a canonical URL.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "RelatedArtifact"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "clinicaltrials-gov",
"map" : "Citations, Links, Available Study Data/Documents"
},
{
"identity" : "BRIDG5.1",
"map" : "StudyProtocolDocument, StudyProtocolDocumentVersion"
}]
},
{
"id" : "ResearchStudy.keyword",
"path" : "ResearchStudy.keyword",
"short" : "Used to search for the study",
"definition" : "Key terms to aid in searching for or filtering the study.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ResearchStudyKeyword"
}],
"strength" : "example",
"description" : "Words associated with the study that may be useful in discovery."
},
"mapping" : [{
"identity" : "clinicaltrials-gov",
"map" : "Keywords"
},
{
"identity" : "BRIDG5.1",
"map" : "DocumentVersion.keywordCode; DocumentVersion.keywordText"
}]
},
{
"id" : "ResearchStudy.location",
"path" : "ResearchStudy.location",
"short" : "Geographic region(s) for study",
"definition" : "Indicates a country, state or other region where the study is taking place.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Jurisdiction"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "extensible",
"description" : "Countries and regions within which this artifact is targeted for use.",
"valueSet" : "http://hl7.org/fhir/ValueSet/jurisdiction"
},
"mapping" : [{
"identity" : "BRIDG5.1",
"map" : "StudyProtocolVersion.participatingLocationCode"
}]
},
{
"id" : "ResearchStudy.description",
"path" : "ResearchStudy.description",
"short" : "What this is study doing",
"definition" : "A full description of how the study is being conducted.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "markdown"
}],
"mapping" : [{
"identity" : "clinicaltrials-gov",
"map" : "Detailed Description"
},
{
"identity" : "BRIDG5.1",
"map" : "StudyProtocolDocumentVersion.publicDescription"
}]
},
{
"id" : "ResearchStudy.enrollment",
"path" : "ResearchStudy.enrollment",
"short" : "Inclusion & exclusion criteria",
"definition" : "Reference to a Group that defines the criteria for and quantity of subjects participating in the study. E.g. \" 200 female Europeans between the ages of 20 and 45 with early onset diabetes\".",
"comment" : "The Group referenced should not generally enumerate specific subjects. Subjects will be linked to the study using the ResearchSubject resource.",
"alias" : ["patient"],
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Group"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "clinicaltrials-gov",
"map" : "Enrollment; Number of Groups/Cohorts (= number of \"enrollment\" instances); Groups (Group/Cohort Label = Group.name; Group/Cohort Description = Group.description); Eligibility (Group criteria)"
},
{
"identity" : "w5",
"map" : "FiveWs.subject[x]"
},
{
"identity" : "BRIDG5.1",
"map" : "InterventionalStudyProtocol.interventionGroupQuantity"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=SBJ].role"
},
{
"identity" : "w5",
"map" : "FiveWs.subject"
}]
},
{
"id" : "ResearchStudy.period",
"path" : "ResearchStudy.period",
"short" : "When the study began and ended",
"definition" : "Identifies the start date and the expected (or actual, depending on status) end date for the study.",
"alias" : ["timing"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Period"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "clinicaltrials-gov",
"map" : "Study Start Date (start); Study Completion Date (end)"
},
{
"identity" : "w5",
"map" : "FiveWs.done[x]"
},
{
"identity" : "BRIDG5.1",
"map" : "ProjectConduct.dateRange; StudyProtocolVersion.plannedDuration"
},
{
"identity" : "rim",
"map" : ".effectiveTime"
}]
},
{
"id" : "ResearchStudy.sponsor",
"path" : "ResearchStudy.sponsor",
"short" : "Organization that initiates and is legally responsible for the study",
"definition" : "An organization that initiates the investigation and is legally responsible for the study.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "clinicaltrials-gov",
"map" : "Sponsor"
},
{
"identity" : "w5",
"map" : "FiveWs.actor"
},
{
"identity" : "BRIDG5.1",
"map" : "RegulatoryApplicationSponsor; StudyLegalSponsor; StudyProtocolVersion.responsiblePartyCode"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]"
}]
},
{
"id" : "ResearchStudy.principalInvestigator",
"path" : "ResearchStudy.principalInvestigator",
"short" : "Researcher who oversees multiple aspects of the study",
"definition" : "A researcher in a study who oversees multiple aspects of the study, such as concept development, protocol writing, protocol submission for IRB approval, participant recruitment, informed consent, data collection, analysis, interpretation and presentation.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "clinicaltrials-gov",
"map" : "Principal Investigator"
},
{
"identity" : "w5",
"map" : "FiveWs.actor"
},
{
"identity" : "BRIDG5.1",
"map" : "StudyInvestigator"
}]
},
{
"id" : "ResearchStudy.site",
"path" : "ResearchStudy.site",
"short" : "Facility where study activities are conducted",
"definition" : "A facility in which study activities are conducted.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Location"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "clinicaltrials-gov",
"map" : "Facility"
},
{
"identity" : "w5",
"map" : "FiveWs.where[x]"
},
{
"identity" : "BRIDG5.1",
"map" : "PlannedStudySite; StudySite"
}]
},
{
"id" : "ResearchStudy.reasonStopped",
"path" : "ResearchStudy.reasonStopped",
"short" : "accrual-goal-met | closed-due-to-toxicity | closed-due-to-lack-of-study-progress | temporarily-closed-per-study-design",
"definition" : "A description and/or code explaining the premature termination of the study.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ResearchStudyReasonStopped"
}],
"strength" : "example",
"description" : "Codes for why the study ended prematurely.",
"valueSet" : "http://hl7.org/fhir/ValueSet/research-study-reason-stopped"
},
"mapping" : [{
"identity" : "clinicaltrials-gov",
"map" : "Why Study Stopped"
},
{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "BRIDG5.1",
"map" : "StudyOverallStatus.studyStoppedReasonCode"
}]
},
{
"id" : "ResearchStudy.note",
"path" : "ResearchStudy.note",
"short" : "Comments made about the study",
"definition" : "Comments made about the study by the performer, subject or other participants.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Annotation"
}],
"mapping" : [{
"identity" : "BRIDG5.1",
"map" : "No BRIDG mapping"
},
{
"identity" : "rim",
"map" : ".inboundRelationship(typeCode=SUBJ].source[classCode=ANNGEN, moodCode=EVN].value[xsi:type=ST]"
}]
},
{
"id" : "ResearchStudy.arm",
"path" : "ResearchStudy.arm",
"short" : "Defined path through the study for a subject",
"definition" : "Describes an expected sequence of events for one of the participants of a study. E.g. Exposure to drug A, wash-out, exposure to drug B, wash-out, follow-up.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"mapping" : [{
"identity" : "clinicaltrials-gov",
"map" : "Arms"
},
{
"identity" : "BRIDG5.1",
"map" : "Arm"
}]
},
{
"id" : "ResearchStudy.arm.name",
"path" : "ResearchStudy.arm.name",
"short" : "Label for study arm",
"definition" : "Unique, human-readable label for this arm of the study.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "string"
}],
"mapping" : [{
"identity" : "clinicaltrials-gov",
"map" : "Arm Label"
},
{
"identity" : "BRIDG5.1",
"map" : "Arm.name"
}]
},
{
"id" : "ResearchStudy.arm.type",
"path" : "ResearchStudy.arm.type",
"short" : "Categorization of study arm",
"definition" : "Categorization of study arm, e.g. experimental, active comparator, placebo comparater.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"mapping" : [{
"identity" : "clinicaltrials-gov",
"map" : "Arm Type"
},
{
"identity" : "BRIDG5.1",
"map" : "Arm.typeCode"
}]
},
{
"id" : "ResearchStudy.arm.description",
"path" : "ResearchStudy.arm.description",
"short" : "Short explanation of study path",
"definition" : "A succinct description of the path through the study that would be followed by a subject adhering to this arm.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"mapping" : [{
"identity" : "clinicaltrials-gov",
"map" : "Arm Description"
},
{
"identity" : "BRIDG5.1",
"map" : "Arm.description"
}]
},
{
"id" : "ResearchStudy.objective",
"path" : "ResearchStudy.objective",
"short" : "A goal for the study",
"definition" : "A goal that the study is aiming to achieve in terms of a scientific question to be answered by the analysis of data collected during the study.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"mapping" : [{
"identity" : "BRIDG5.1",
"map" : "StudyObjective"
}]
},
{
"id" : "ResearchStudy.objective.name",
"path" : "ResearchStudy.objective.name",
"short" : "Label for the objective",
"definition" : "Unique, human-readable label for this objective of the study.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"mapping" : [{
"identity" : "BRIDG5.1",
"map" : "No BRIDG mapping (BRIDG has a description, but not a name)"
}]
},
{
"id" : "ResearchStudy.objective.type",
"path" : "ResearchStudy.objective.type",
"short" : "primary | secondary | exploratory",
"definition" : "The kind of study objective.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ResearchStudyObjectiveType"
}],
"strength" : "preferred",
"description" : "Codes for the kind of study objective.",
"valueSet" : "http://hl7.org/fhir/ValueSet/research-study-objective-type"
},
"mapping" : [{
"identity" : "BRIDG5.1",
"map" : "StudyObjective.typeCode"
}]
}]
}
}
},
{
"fullUrl" : "http://hl7.org/fhir/StructureDefinition/ResearchSubject",
"resource" : {
"resourceType" : "StructureDefinition",
"id" : "ResearchSubject",
"meta" : {
"lastUpdated" : "2019-11-01T09:29:23.356+11:00"
},
"text" : {
"status" : "generated",
"div" : "Name Flags Card. Type Description & Constraints ResearchSubject TU DomainResource Physical entity which is the primary unit of interest in the study
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension identifier Σ 0..* Identifier Business Identifier for research subject in a study
status ?!Σ 1..1 code candidate | eligible | follow-up | ineligible | not-registered | off-study | on-study | on-study-intervention | on-study-observation | pending-on-study | potential-candidate | screening | withdrawn
ResearchSubjectStatus (Required) period Σ 0..1 Period Start and end of participation study Σ 1..1 Reference(ResearchStudy) Study subject is part of individual Σ 1..1 Reference(Patient) Who is part of study assignedArm 0..1 string What path should be followed actualArm 0..1 string What path was followed consent 0..1 Reference(Consent) Agreement to participate in study
Documentation for this format
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Specialized.Public Health & Research"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 1
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "patient"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "brr"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/ResearchSubject",
"version" : "4.0.1",
"name" : "ResearchSubject",
"status" : "draft",
"date" : "2019-11-01T09:29:23+11:00",
"publisher" : "Health Level Seven International (Biomedical Research and Regulation)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/rcrim/index.cfm"
}]
}],
"description" : "A physical entity which is the primary unit of operational and/or administrative interest in a study.",
"fhirVersion" : "4.0.1",
"mapping" : [{
"identity" : "BRIDG5.1",
"uri" : "https://bridgmodel.nci.nih.gov",
"name" : "BRIDG 5.1 Mapping"
},
{
"identity" : "v2",
"uri" : "http://hl7.org/v2",
"name" : "HL7 v2 Mapping"
},
{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/fivews",
"name" : "FiveWs Pattern Mapping"
}],
"kind" : "resource",
"abstract" : false,
"type" : "ResearchSubject",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "ResearchSubject",
"path" : "ResearchSubject",
"short" : "Physical entity which is the primary unit of interest in the study",
"definition" : "A physical entity which is the primary unit of operational and/or administrative interest in a study.",
"comment" : "Need to make sure we encompass public health studies.",
"alias" : ["Study Subject"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "ResearchSubject",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "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",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.`div`.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "BRIDG5.1",
"map" : "StudySubject"
},
{
"identity" : "v2",
"map" : "OBX"
},
{
"identity" : "rim",
"map" : "Observation[classCode=CLNTRL, moodCode=EVN]"
}]
},
{
"id" : "ResearchSubject.id",
"path" : "ResearchSubject.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "ResearchSubject.meta",
"path" : "ResearchSubject.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "ResearchSubject.implicitRules",
"path" : "ResearchSubject.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "ResearchSubject.language",
"path" : "ResearchSubject.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "ResearchSubject.text",
"path" : "ResearchSubject.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "ResearchSubject.contained",
"path" : "ResearchSubject.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ResearchSubject.extension",
"path" : "ResearchSubject.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ResearchSubject.modifierExtension",
"path" : "ResearchSubject.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ResearchSubject.identifier",
"path" : "ResearchSubject.identifier",
"short" : "Business Identifier for research subject in a study",
"definition" : "Identifiers assigned to this research subject for a study.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ResearchSubject.identifier",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Identifier"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "BRIDG5.1",
"map" : "StudySubject > Subject.identifier"
},
{
"identity" : "rim",
"map" : ".identifier"
}]
},
{
"id" : "ResearchSubject.status",
"path" : "ResearchSubject.status",
"short" : "candidate | eligible | follow-up | ineligible | not-registered | off-study | on-study | on-study-intervention | on-study-observation | pending-on-study | potential-candidate | screening | withdrawn",
"definition" : "The current state of the subject.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ResearchSubject.status",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ResearchSubjectStatus"
}],
"strength" : "required",
"description" : "Indicates the progression of a study subject through a study.",
"valueSet" : "http://hl7.org/fhir/ValueSet/research-subject-status|4.0.1"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.status"
},
{
"identity" : "BRIDG5.1",
"map" : "StudySubject.statusCode"
},
{
"identity" : "rim",
"map" : ".status"
}]
},
{
"id" : "ResearchSubject.period",
"path" : "ResearchSubject.period",
"short" : "Start and end of participation",
"definition" : "The dates the subject began and ended their participation in the study.",
"alias" : ["timing"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "ResearchSubject.period",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Period"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.planned"
},
{
"identity" : "BRIDG5.1",
"map" : "PerformedStudySubjectMilestone.studyReferenceDateRange"
}]
},
{
"id" : "ResearchSubject.study",
"path" : "ResearchSubject.study",
"short" : "Study subject is part of",
"definition" : "Reference to the study the subject is participating in.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ResearchSubject.study",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ResearchStudy"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "BRIDG5.1",
"map" : "StudySubjectProtocolVersionRelationship"
}]
},
{
"id" : "ResearchSubject.individual",
"path" : "ResearchSubject.individual",
"short" : "Who is part of study",
"definition" : "The record of the person or animal who is involved in the study.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ResearchSubject.individual",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "BRIDG5.1",
"map" : "StudySubject"
}]
},
{
"id" : "ResearchSubject.assignedArm",
"path" : "ResearchSubject.assignedArm",
"short" : "What path should be followed",
"definition" : "The name of the arm in the study the subject is expected to follow as part of this study.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ResearchSubject.assignedArm",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "BRIDG5.1",
"map" : "Arm > ExperimentalUnit > BiologicEntity > Subject > StudySubject"
}]
},
{
"id" : "ResearchSubject.actualArm",
"path" : "ResearchSubject.actualArm",
"short" : "What path was followed",
"definition" : "The name of the arm in the study the subject actually followed as part of this study.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ResearchSubject.actualArm",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "BRIDG5.1",
"map" : "Arm > ExperimentalUnit > BiologicEntity > Subject > StudySubject"
}]
},
{
"id" : "ResearchSubject.consent",
"path" : "ResearchSubject.consent",
"short" : "Agreement to participate in study",
"definition" : "A record of the patient's informed agreement to participate in the study.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ResearchSubject.consent",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Consent"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "BRIDG5.1",
"map" : "ResearchStudy.consent is related to PerformedStudySubjectMilestone.informedConsentIndicator in that the informedConsentIndicator can be derived from the data in the Consent resource."
}]
}]
},
"differential" : {
"element" : [{
"id" : "ResearchSubject",
"path" : "ResearchSubject",
"short" : "Physical entity which is the primary unit of interest in the study",
"definition" : "A physical entity which is the primary unit of operational and/or administrative interest in a study.",
"comment" : "Need to make sure we encompass public health studies.",
"alias" : ["Study Subject"],
"min" : 0,
"max" : "*",
"mapping" : [{
"identity" : "BRIDG5.1",
"map" : "StudySubject"
},
{
"identity" : "v2",
"map" : "OBX"
},
{
"identity" : "rim",
"map" : "Observation[classCode=CLNTRL, moodCode=EVN]"
}]
},
{
"id" : "ResearchSubject.identifier",
"path" : "ResearchSubject.identifier",
"short" : "Business Identifier for research subject in a study",
"definition" : "Identifiers assigned to this research subject for a study.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Identifier"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "BRIDG5.1",
"map" : "StudySubject > Subject.identifier"
},
{
"identity" : "rim",
"map" : ".identifier"
}]
},
{
"id" : "ResearchSubject.status",
"path" : "ResearchSubject.status",
"short" : "candidate | eligible | follow-up | ineligible | not-registered | off-study | on-study | on-study-intervention | on-study-observation | pending-on-study | potential-candidate | screening | withdrawn",
"definition" : "The current state of the subject.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ResearchSubjectStatus"
}],
"strength" : "required",
"description" : "Indicates the progression of a study subject through a study.",
"valueSet" : "http://hl7.org/fhir/ValueSet/research-subject-status|4.0.1"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.status"
},
{
"identity" : "BRIDG5.1",
"map" : "StudySubject.statusCode"
},
{
"identity" : "rim",
"map" : ".status"
}]
},
{
"id" : "ResearchSubject.period",
"path" : "ResearchSubject.period",
"short" : "Start and end of participation",
"definition" : "The dates the subject began and ended their participation in the study.",
"alias" : ["timing"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Period"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.planned"
},
{
"identity" : "BRIDG5.1",
"map" : "PerformedStudySubjectMilestone.studyReferenceDateRange"
}]
},
{
"id" : "ResearchSubject.study",
"path" : "ResearchSubject.study",
"short" : "Study subject is part of",
"definition" : "Reference to the study the subject is participating in.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ResearchStudy"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "BRIDG5.1",
"map" : "StudySubjectProtocolVersionRelationship"
}]
},
{
"id" : "ResearchSubject.individual",
"path" : "ResearchSubject.individual",
"short" : "Who is part of study",
"definition" : "The record of the person or animal who is involved in the study.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "BRIDG5.1",
"map" : "StudySubject"
}]
},
{
"id" : "ResearchSubject.assignedArm",
"path" : "ResearchSubject.assignedArm",
"short" : "What path should be followed",
"definition" : "The name of the arm in the study the subject is expected to follow as part of this study.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"mapping" : [{
"identity" : "BRIDG5.1",
"map" : "Arm > ExperimentalUnit > BiologicEntity > Subject > StudySubject"
}]
},
{
"id" : "ResearchSubject.actualArm",
"path" : "ResearchSubject.actualArm",
"short" : "What path was followed",
"definition" : "The name of the arm in the study the subject actually followed as part of this study.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"mapping" : [{
"identity" : "BRIDG5.1",
"map" : "Arm > ExperimentalUnit > BiologicEntity > Subject > StudySubject"
}]
},
{
"id" : "ResearchSubject.consent",
"path" : "ResearchSubject.consent",
"short" : "Agreement to participate in study",
"definition" : "A record of the patient's informed agreement to participate in the study.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Consent"]
}],
"mapping" : [{
"identity" : "BRIDG5.1",
"map" : "ResearchStudy.consent is related to PerformedStudySubjectMilestone.informedConsentIndicator in that the informedConsentIndicator can be derived from the data in the Consent resource."
}]
}]
}
}
},
{
"fullUrl" : "http://hl7.org/fhir/StructureDefinition/RiskAssessment",
"resource" : {
"resourceType" : "StructureDefinition",
"id" : "RiskAssessment",
"meta" : {
"lastUpdated" : "2019-11-01T09:29:23.356+11:00"
},
"text" : {
"status" : "generated",
"div" : "Name Flags Card. Type Description & Constraints RiskAssessment TU DomainResource Potential outcomes for a subject with likelihood
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension identifier Σ 0..* Identifier Unique identifier for the assessment
basedOn 0..1 Reference(Any) Request fulfilled by this assessment parent 0..1 Reference(Any) Part of this occurrence status Σ 1..1 code registered | preliminary | final | amended +
ObservationStatus (Required) method Σ 0..1 CodeableConcept Evaluation mechanism code Σ 0..1 CodeableConcept Type of assessment subject Σ 1..1 Reference(Patient | Group) Who/what does assessment apply to? encounter Σ 0..1 Reference(Encounter) Where was assessment performed? occurrence[x] Σ 0..1 When was assessment made? occurrenceDateTime dateTime occurrencePeriod Period condition Σ 0..1 Reference(Condition) Condition assessed performer Σ 0..1 Reference(Practitioner | PractitionerRole | Device) Who did assessment? reasonCode 0..* CodeableConcept Why the assessment was necessary?
reasonReference 0..* Reference(Condition | Observation | DiagnosticReport | DocumentReference) Why the assessment was necessary?
basis 0..* Reference(Any) Information used in assessment
prediction I 0..* BackboneElement Outcome predicted
+ Rule: Must be <= 100
outcome 0..1 CodeableConcept Possible outcome for the subject probability[x] I 0..1 Likelihood of specified outcome
+ Rule: low and high must be percentages, if present probabilityDecimal decimal probabilityRange Range qualitativeRisk 0..1 CodeableConcept Likelihood of specified outcome as a qualitative value
Risk Probability (Example) relativeRisk 0..1 decimal Relative likelihood when[x] 0..1 Timeframe or age range whenPeriod Period whenRange Range rationale 0..1 string Explanation of prediction mitigation 0..1 string How to reduce risk note 0..* Annotation Comments on the risk assessment
Documentation for this format
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Clinical.Care Provision"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 1
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "patient"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "cds"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/RiskAssessment",
"version" : "4.0.1",
"name" : "RiskAssessment",
"status" : "draft",
"date" : "2019-11-01T09:29:23+11:00",
"publisher" : "Health Level Seven International (Clinical Decision Support)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/dss/index.cfm"
}]
}],
"description" : "An assessment of the likely outcome(s) for a patient or other subject as well as the likelihood of each outcome.",
"fhirVersion" : "4.0.1",
"mapping" : [{
"identity" : "workflow",
"uri" : "http://hl7.org/fhir/workflow",
"name" : "Workflow Pattern"
},
{
"identity" : "v2",
"uri" : "http://hl7.org/v2",
"name" : "HL7 v2 Mapping"
},
{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
},
{
"identity" : "openehr",
"uri" : "http://openehr.org",
"name" : "Open EHR Archetype Mapping"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/fivews",
"name" : "FiveWs Pattern Mapping"
}],
"kind" : "resource",
"abstract" : false,
"type" : "RiskAssessment",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "RiskAssessment",
"path" : "RiskAssessment",
"short" : "Potential outcomes for a subject with likelihood",
"definition" : "An assessment of the likely outcome(s) for a patient or other subject as well as the likelihood of each outcome.",
"alias" : ["Prognosis"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "RiskAssessment",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "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",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.`div`.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "workflow",
"map" : "Event"
},
{
"identity" : "v2",
"map" : "N/A"
},
{
"identity" : "rim",
"map" : "Observation[classCode=OBS, moodCode=EVN, code=\"Risk Assessment\"]"
},
{
"identity" : "openehr",
"map" : "OpenEHR-EHR-EVALUATION.risk.v1"
}]
},
{
"id" : "RiskAssessment.id",
"path" : "RiskAssessment.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "RiskAssessment.meta",
"path" : "RiskAssessment.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "RiskAssessment.implicitRules",
"path" : "RiskAssessment.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "RiskAssessment.language",
"path" : "RiskAssessment.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "RiskAssessment.text",
"path" : "RiskAssessment.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "RiskAssessment.contained",
"path" : "RiskAssessment.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "RiskAssessment.extension",
"path" : "RiskAssessment.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "RiskAssessment.modifierExtension",
"path" : "RiskAssessment.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "RiskAssessment.identifier",
"path" : "RiskAssessment.identifier",
"short" : "Unique identifier for the assessment",
"definition" : "Business identifier assigned to the risk assessment.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "RiskAssessment.identifier",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Identifier"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.identifier"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "rim",
"map" : ".id"
},
{
"identity" : "openehr",
"map" : "Workflow Identifier"
}]
},
{
"id" : "RiskAssessment.basedOn",
"path" : "RiskAssessment.basedOn",
"short" : "Request fulfilled by this assessment",
"definition" : "A reference to the request that is fulfilled by this risk assessment.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "RiskAssessment.basedOn",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.basedOn"
}]
},
{
"id" : "RiskAssessment.parent",
"path" : "RiskAssessment.parent",
"short" : "Part of this occurrence",
"definition" : "A reference to a resource that this risk assessment is part of, such as a Procedure.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "RiskAssessment.parent",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.partOf"
}]
},
{
"id" : "RiskAssessment.status",
"path" : "RiskAssessment.status",
"short" : "registered | preliminary | final | amended +",
"definition" : "The status of the RiskAssessment, using the same statuses as an Observation.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "RiskAssessment.status",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "RiskAssessmentStatus"
}],
"strength" : "required",
"description" : "The status of the risk assessment; e.g. preliminary, final, amended, etc.",
"valueSet" : "http://hl7.org/fhir/ValueSet/observation-status|4.0.1"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.status"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
}]
},
{
"id" : "RiskAssessment.method",
"path" : "RiskAssessment.method",
"short" : "Evaluation mechanism",
"definition" : "The algorithm, process or mechanism used to evaluate the risk.",
"requirements" : "The method can influence the results of the assessment.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "RiskAssessment.method",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "RiskAssessmentMethod"
}],
"strength" : "example",
"description" : "The mechanism or algorithm used to make the assessment; e.g. TIMI, PRISM, Cardiff Type 2 diabetes, etc."
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.class"
},
{
"identity" : "rim",
"map" : ".methodCode"
}]
},
{
"id" : "RiskAssessment.code",
"path" : "RiskAssessment.code",
"short" : "Type of assessment",
"definition" : "The type of the risk assessment performed.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "RiskAssessment.code",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.code"
},
{
"identity" : "w5",
"map" : "FiveWs.what[x]"
}]
},
{
"id" : "RiskAssessment.subject",
"path" : "RiskAssessment.subject",
"short" : "Who/what does assessment apply to?",
"definition" : "The patient or group the risk assessment applies to.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "RiskAssessment.subject",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Group"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.subject"
},
{
"identity" : "w5",
"map" : "FiveWs.subject[x]"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=SBJ].role"
},
{
"identity" : "openehr",
"map" : "Subject of Care"
},
{
"identity" : "w5",
"map" : "FiveWs.subject"
}]
},
{
"id" : "RiskAssessment.encounter",
"path" : "RiskAssessment.encounter",
"short" : "Where was assessment performed?",
"definition" : "The encounter where the assessment was performed.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "RiskAssessment.encounter",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Encounter"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.encounter"
},
{
"identity" : "w5",
"map" : "FiveWs.context"
},
{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN]"
}]
},
{
"id" : "RiskAssessment.occurrence[x]",
"path" : "RiskAssessment.occurrence[x]",
"short" : "When was assessment made?",
"definition" : "The date (and possibly time) the risk assessment was performed.",
"requirements" : "The assessment results lose validity the more time elapses from when they are first made.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "RiskAssessment.occurrence[x]",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
},
{
"code" : "Period"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.occurrence[x]"
},
{
"identity" : "w5",
"map" : "FiveWs.done[x]"
},
{
"identity" : "rim",
"map" : ".effectiveTime"
}]
},
{
"id" : "RiskAssessment.condition",
"path" : "RiskAssessment.condition",
"short" : "Condition assessed",
"definition" : "For assessments or prognosis specific to a particular condition, indicates the condition being assessed.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "RiskAssessment.condition",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Condition"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=SUBJ].target[classCode=OBS, moodCode=EVN]"
}]
},
{
"id" : "RiskAssessment.performer",
"path" : "RiskAssessment.performer",
"short" : "Who did assessment?",
"definition" : "The provider or software application that performed the assessment.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "RiskAssessment.performer",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Device"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.performer.actor"
},
{
"identity" : "w5",
"map" : "FiveWs.actor"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=PFM].role[classCode=ASSIGNED]"
},
{
"identity" : "openehr",
"map" : "Information Provider"
}]
},
{
"id" : "RiskAssessment.reasonCode",
"path" : "RiskAssessment.reasonCode",
"short" : "Why the assessment was necessary?",
"definition" : "The reason the risk assessment was performed.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "RiskAssessment.reasonCode",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.reasonCode"
},
{
"identity" : "w5",
"map" : "FiveWs.why[x]"
}]
},
{
"id" : "RiskAssessment.reasonReference",
"path" : "RiskAssessment.reasonReference",
"short" : "Why the assessment was necessary?",
"definition" : "Resources supporting the reason the risk assessment was performed.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "RiskAssessment.reasonReference",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Condition",
"http://hl7.org/fhir/StructureDefinition/Observation",
"http://hl7.org/fhir/StructureDefinition/DiagnosticReport",
"http://hl7.org/fhir/StructureDefinition/DocumentReference"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.reasonReference"
},
{
"identity" : "w5",
"map" : "FiveWs.why[x]"
}]
},
{
"id" : "RiskAssessment.basis",
"path" : "RiskAssessment.basis",
"short" : "Information used in assessment",
"definition" : "Indicates the source data considered as part of the assessment (for example, FamilyHistory, Observations, Procedures, Conditions, etc.).",
"min" : 0,
"max" : "*",
"base" : {
"path" : "RiskAssessment.basis",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=DRIV].target"
},
{
"identity" : "openehr",
"map" : "Risk Factor; Link to Evidence"
}]
},
{
"id" : "RiskAssessment.prediction",
"path" : "RiskAssessment.prediction",
"short" : "Outcome predicted",
"definition" : "Describes the expected outcome for the subject.",
"comment" : "Multiple repetitions can be used to identify the same type of outcome in different timeframes as well as different types of outcomes.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "RiskAssessment.prediction",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ras-2",
"severity" : "error",
"human" : "Must be <= 100",
"expression" : "probability.empty() or ((probability is decimal) implies ((probability as decimal) <= 100))",
"xpath" : "not(f:probabilityDecimal) or f:probabilityDecimal/@value <= 100"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=VALUE].target[classCod=OBS, moodCode=RISK]"
}]
},
{
"id" : "RiskAssessment.prediction.id",
"path" : "RiskAssessment.prediction.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "RiskAssessment.prediction.extension",
"path" : "RiskAssessment.prediction.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "RiskAssessment.prediction.modifierExtension",
"path" : "RiskAssessment.prediction.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "RiskAssessment.prediction.outcome",
"path" : "RiskAssessment.prediction.outcome",
"short" : "Possible outcome for the subject",
"definition" : "One of the potential outcomes for the patient (e.g. remission, death, a particular condition).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "RiskAssessment.prediction.outcome",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "RiskAssessmentOutcome"
}],
"strength" : "example",
"description" : "The condition or other outcome; e.g. death, remission, amputation, infection, etc."
},
"mapping" : [{
"identity" : "rim",
"map" : ".value"
},
{
"identity" : "openehr",
"map" : "Risk"
}]
},
{
"id" : "RiskAssessment.prediction.probability[x]",
"path" : "RiskAssessment.prediction.probability[x]",
"short" : "Likelihood of specified outcome",
"definition" : "Indicates how likely the outcome is (in the specified timeframe).",
"comment" : "If range is used, it represents the lower and upper bounds of certainty; e.g. 40-60% Decimal values are expressed as percentages as well (max = 100).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "RiskAssessment.prediction.probability[x]",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "decimal"
},
{
"code" : "Range"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ras-1",
"severity" : "error",
"human" : "low and high must be percentages, if present",
"expression" : "(low.empty() or ((low.code = '%') and (low.system = %ucum))) and (high.empty() or ((high.code = '%') and (high.system = %ucum)))",
"xpath" : "(not(f:low) or f:low[f:code/@value='%' and f:system/@value='http://unitsofmeasure.org']) and (not(f:high) or f:high[f:code/@value='%' and f:system/@value='http://unitsofmeasure.org'])"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"probability\"].value"
},
{
"identity" : "openehr",
"map" : "Category"
}]
},
{
"id" : "RiskAssessment.prediction.qualitativeRisk",
"path" : "RiskAssessment.prediction.qualitativeRisk",
"short" : "Likelihood of specified outcome as a qualitative value",
"definition" : "Indicates how likely the outcome is (in the specified timeframe), expressed as a qualitative value (e.g. low, medium, or high).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "RiskAssessment.prediction.qualitativeRisk",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "RiskAssessmentProbability"
}],
"strength" : "example",
"description" : "The likelihood of the occurrence of a specified outcome.",
"valueSet" : "http://hl7.org/fhir/ValueSet/risk-probability"
}
},
{
"id" : "RiskAssessment.prediction.relativeRisk",
"path" : "RiskAssessment.prediction.relativeRisk",
"short" : "Relative likelihood",
"definition" : "Indicates the risk for this particular subject (with their specific characteristics) divided by the risk of the population in general. (Numbers greater than 1 = higher risk than the population, numbers less than 1 = lower risk.).",
"requirements" : "Absolute risk is less meaningful than relative risk.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "RiskAssessment.prediction.relativeRisk",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "decimal"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"relative risk\"].value"
}]
},
{
"id" : "RiskAssessment.prediction.when[x]",
"path" : "RiskAssessment.prediction.when[x]",
"short" : "Timeframe or age range",
"definition" : "Indicates the period of time or age range of the subject to which the specified probability applies.",
"comment" : "If not specified, the risk applies \"over the subject's lifespan\".",
"min" : 0,
"max" : "1",
"base" : {
"path" : "RiskAssessment.prediction.when[x]",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Period"
},
{
"code" : "Range"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".effectiveTime or .inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"age\"].value"
}]
},
{
"id" : "RiskAssessment.prediction.rationale",
"path" : "RiskAssessment.prediction.rationale",
"short" : "Explanation of prediction",
"definition" : "Additional information explaining the basis for the prediction.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "RiskAssessment.prediction.rationale",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".reasonCode.text"
},
{
"identity" : "openehr",
"map" : "Rationale"
}]
},
{
"id" : "RiskAssessment.mitigation",
"path" : "RiskAssessment.mitigation",
"short" : "How to reduce risk",
"definition" : "A description of the steps that might be taken to reduce the identified risk(s).",
"requirements" : "One of the main reasons for assessing risks is to identify whether interventional steps are needed to reduce risk.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "RiskAssessment.mitigation",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=MTGT].target[classCode=ACT, moodCode=EVN].text"
}]
},
{
"id" : "RiskAssessment.note",
"path" : "RiskAssessment.note",
"short" : "Comments on the risk assessment",
"definition" : "Additional comments about the risk assessment.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "RiskAssessment.note",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Annotation"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.note"
}]
}]
},
"differential" : {
"element" : [{
"id" : "RiskAssessment",
"path" : "RiskAssessment",
"short" : "Potential outcomes for a subject with likelihood",
"definition" : "An assessment of the likely outcome(s) for a patient or other subject as well as the likelihood of each outcome.",
"alias" : ["Prognosis"],
"min" : 0,
"max" : "*",
"mapping" : [{
"identity" : "workflow",
"map" : "Event"
},
{
"identity" : "v2",
"map" : "N/A"
},
{
"identity" : "rim",
"map" : "Observation[classCode=OBS, moodCode=EVN, code=\"Risk Assessment\"]"
},
{
"identity" : "openehr",
"map" : "OpenEHR-EHR-EVALUATION.risk.v1"
}]
},
{
"id" : "RiskAssessment.identifier",
"path" : "RiskAssessment.identifier",
"short" : "Unique identifier for the assessment",
"definition" : "Business identifier assigned to the risk assessment.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Identifier"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.identifier"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "rim",
"map" : ".id"
},
{
"identity" : "openehr",
"map" : "Workflow Identifier"
}]
},
{
"id" : "RiskAssessment.basedOn",
"path" : "RiskAssessment.basedOn",
"short" : "Request fulfilled by this assessment",
"definition" : "A reference to the request that is fulfilled by this risk assessment.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Event.basedOn"
}]
},
{
"id" : "RiskAssessment.parent",
"path" : "RiskAssessment.parent",
"short" : "Part of this occurrence",
"definition" : "A reference to a resource that this risk assessment is part of, such as a Procedure.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Event.partOf"
}]
},
{
"id" : "RiskAssessment.status",
"path" : "RiskAssessment.status",
"short" : "registered | preliminary | final | amended +",
"definition" : "The status of the RiskAssessment, using the same statuses as an Observation.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "RiskAssessmentStatus"
}],
"strength" : "required",
"description" : "The status of the risk assessment; e.g. preliminary, final, amended, etc.",
"valueSet" : "http://hl7.org/fhir/ValueSet/observation-status|4.0.1"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.status"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
}]
},
{
"id" : "RiskAssessment.method",
"path" : "RiskAssessment.method",
"short" : "Evaluation mechanism",
"definition" : "The algorithm, process or mechanism used to evaluate the risk.",
"requirements" : "The method can influence the results of the assessment.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "RiskAssessmentMethod"
}],
"strength" : "example",
"description" : "The mechanism or algorithm used to make the assessment; e.g. TIMI, PRISM, Cardiff Type 2 diabetes, etc."
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.class"
},
{
"identity" : "rim",
"map" : ".methodCode"
}]
},
{
"id" : "RiskAssessment.code",
"path" : "RiskAssessment.code",
"short" : "Type of assessment",
"definition" : "The type of the risk assessment performed.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.code"
},
{
"identity" : "w5",
"map" : "FiveWs.what[x]"
}]
},
{
"id" : "RiskAssessment.subject",
"path" : "RiskAssessment.subject",
"short" : "Who/what does assessment apply to?",
"definition" : "The patient or group the risk assessment applies to.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Group"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.subject"
},
{
"identity" : "w5",
"map" : "FiveWs.subject[x]"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=SBJ].role"
},
{
"identity" : "openehr",
"map" : "Subject of Care"
},
{
"identity" : "w5",
"map" : "FiveWs.subject"
}]
},
{
"id" : "RiskAssessment.encounter",
"path" : "RiskAssessment.encounter",
"short" : "Where was assessment performed?",
"definition" : "The encounter where the assessment was performed.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Encounter"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.encounter"
},
{
"identity" : "w5",
"map" : "FiveWs.context"
},
{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN]"
}]
},
{
"id" : "RiskAssessment.occurrence[x]",
"path" : "RiskAssessment.occurrence[x]",
"short" : "When was assessment made?",
"definition" : "The date (and possibly time) the risk assessment was performed.",
"requirements" : "The assessment results lose validity the more time elapses from when they are first made.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "dateTime"
},
{
"code" : "Period"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.occurrence[x]"
},
{
"identity" : "w5",
"map" : "FiveWs.done[x]"
},
{
"identity" : "rim",
"map" : ".effectiveTime"
}]
},
{
"id" : "RiskAssessment.condition",
"path" : "RiskAssessment.condition",
"short" : "Condition assessed",
"definition" : "For assessments or prognosis specific to a particular condition, indicates the condition being assessed.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Condition"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=SUBJ].target[classCode=OBS, moodCode=EVN]"
}]
},
{
"id" : "RiskAssessment.performer",
"path" : "RiskAssessment.performer",
"short" : "Who did assessment?",
"definition" : "The provider or software application that performed the assessment.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Device"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.performer.actor"
},
{
"identity" : "w5",
"map" : "FiveWs.actor"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=PFM].role[classCode=ASSIGNED]"
},
{
"identity" : "openehr",
"map" : "Information Provider"
}]
},
{
"id" : "RiskAssessment.reasonCode",
"path" : "RiskAssessment.reasonCode",
"short" : "Why the assessment was necessary?",
"definition" : "The reason the risk assessment was performed.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Event.reasonCode"
},
{
"identity" : "w5",
"map" : "FiveWs.why[x]"
}]
},
{
"id" : "RiskAssessment.reasonReference",
"path" : "RiskAssessment.reasonReference",
"short" : "Why the assessment was necessary?",
"definition" : "Resources supporting the reason the risk assessment was performed.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Condition",
"http://hl7.org/fhir/StructureDefinition/Observation",
"http://hl7.org/fhir/StructureDefinition/DiagnosticReport",
"http://hl7.org/fhir/StructureDefinition/DocumentReference"]
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Event.reasonReference"
},
{
"identity" : "w5",
"map" : "FiveWs.why[x]"
}]
},
{
"id" : "RiskAssessment.basis",
"path" : "RiskAssessment.basis",
"short" : "Information used in assessment",
"definition" : "Indicates the source data considered as part of the assessment (for example, FamilyHistory, Observations, Procedures, Conditions, etc.).",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"mapping" : [{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=DRIV].target"
},
{
"identity" : "openehr",
"map" : "Risk Factor; Link to Evidence"
}]
},
{
"id" : "RiskAssessment.prediction",
"path" : "RiskAssessment.prediction",
"short" : "Outcome predicted",
"definition" : "Describes the expected outcome for the subject.",
"comment" : "Multiple repetitions can be used to identify the same type of outcome in different timeframes as well as different types of outcomes.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ras-2",
"severity" : "error",
"human" : "Must be <= 100",
"expression" : "probability is decimal implies (probability as decimal) <= 100",
"xpath" : "not(f:probabilityDecimal) or f:probabilityDecimal/@value <= 100"
}],
"mapping" : [{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=VALUE].target[classCod=OBS, moodCode=RISK]"
}]
},
{
"id" : "RiskAssessment.prediction.outcome",
"path" : "RiskAssessment.prediction.outcome",
"short" : "Possible outcome for the subject",
"definition" : "One of the potential outcomes for the patient (e.g. remission, death, a particular condition).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "RiskAssessmentOutcome"
}],
"strength" : "example",
"description" : "The condition or other outcome; e.g. death, remission, amputation, infection, etc."
},
"mapping" : [{
"identity" : "rim",
"map" : ".value"
},
{
"identity" : "openehr",
"map" : "Risk"
}]
},
{
"id" : "RiskAssessment.prediction.probability[x]",
"path" : "RiskAssessment.prediction.probability[x]",
"short" : "Likelihood of specified outcome",
"definition" : "Indicates how likely the outcome is (in the specified timeframe).",
"comment" : "If range is used, it represents the lower and upper bounds of certainty; e.g. 40-60% Decimal values are expressed as percentages as well (max = 100).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "decimal"
},
{
"code" : "Range"
}],
"constraint" : [{
"key" : "ras-1",
"severity" : "error",
"human" : "low and high must be percentages, if present",
"expression" : "(low.empty() or ((low.code = '%') and (low.system = %ucum))) and (high.empty() or ((high.code = '%') and (high.system = %ucum)))",
"xpath" : "(not(f:low) or f:low[f:code/@value='%' and f:system/@value='http://unitsofmeasure.org']) and (not(f:high) or f:high[f:code/@value='%' and f:system/@value='http://unitsofmeasure.org'])"
}],
"mapping" : [{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"probability\"].value"
},
{
"identity" : "openehr",
"map" : "Category"
}]
},
{
"id" : "RiskAssessment.prediction.qualitativeRisk",
"path" : "RiskAssessment.prediction.qualitativeRisk",
"short" : "Likelihood of specified outcome as a qualitative value",
"definition" : "Indicates how likely the outcome is (in the specified timeframe), expressed as a qualitative value (e.g. low, medium, or high).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "RiskAssessmentProbability"
}],
"strength" : "example",
"description" : "The likelihood of the occurrence of a specified outcome.",
"valueSet" : "http://hl7.org/fhir/ValueSet/risk-probability"
}
},
{
"id" : "RiskAssessment.prediction.relativeRisk",
"path" : "RiskAssessment.prediction.relativeRisk",
"short" : "Relative likelihood",
"definition" : "Indicates the risk for this particular subject (with their specific characteristics) divided by the risk of the population in general. (Numbers greater than 1 = higher risk than the population, numbers less than 1 = lower risk.).",
"requirements" : "Absolute risk is less meaningful than relative risk.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "decimal"
}],
"mapping" : [{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"relative risk\"].value"
}]
},
{
"id" : "RiskAssessment.prediction.when[x]",
"path" : "RiskAssessment.prediction.when[x]",
"short" : "Timeframe or age range",
"definition" : "Indicates the period of time or age range of the subject to which the specified probability applies.",
"comment" : "If not specified, the risk applies \"over the subject's lifespan\".",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Period"
},
{
"code" : "Range"
}],
"mapping" : [{
"identity" : "rim",
"map" : ".effectiveTime or .inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"age\"].value"
}]
},
{
"id" : "RiskAssessment.prediction.rationale",
"path" : "RiskAssessment.prediction.rationale",
"short" : "Explanation of prediction",
"definition" : "Additional information explaining the basis for the prediction.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"mapping" : [{
"identity" : "rim",
"map" : ".reasonCode.text"
},
{
"identity" : "openehr",
"map" : "Rationale"
}]
},
{
"id" : "RiskAssessment.mitigation",
"path" : "RiskAssessment.mitigation",
"short" : "How to reduce risk",
"definition" : "A description of the steps that might be taken to reduce the identified risk(s).",
"requirements" : "One of the main reasons for assessing risks is to identify whether interventional steps are needed to reduce risk.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"mapping" : [{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=MTGT].target[classCode=ACT, moodCode=EVN].text"
}]
},
{
"id" : "RiskAssessment.note",
"path" : "RiskAssessment.note",
"short" : "Comments on the risk assessment",
"definition" : "Additional comments about the risk assessment.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Annotation"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Event.note"
}]
}]
}
}
},
{
"fullUrl" : "http://hl7.org/fhir/StructureDefinition/RiskEvidenceSynthesis",
"resource" : {
"resourceType" : "StructureDefinition",
"id" : "RiskEvidenceSynthesis",
"meta" : {
"lastUpdated" : "2019-11-01T09:29:23.356+11:00"
},
"text" : {
"status" : "generated",
"div" : "Name Flags Card. Type Description & Constraints RiskEvidenceSynthesis ITU DomainResource A quantified estimate of risk based on a body of evidence
+ 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 url Σ 0..1 uri Canonical identifier for this risk evidence synthesis, represented as a URI (globally unique) identifier Σ 0..* Identifier Additional identifier for the risk evidence synthesis
version Σ 0..1 string Business version of the risk evidence synthesis name ΣI 0..1 string Name for this risk evidence synthesis (computer friendly) title Σ 0..1 string Name for this risk evidence synthesis (human friendly) status ?!Σ 1..1 code draft | active | retired | unknown
PublicationStatus (Required) date Σ 0..1 dateTime Date last changed publisher Σ 0..1 string Name of the publisher (organization or individual) contact Σ 0..* ContactDetail Contact details for the publisher
description Σ 0..1 markdown Natural language description of the risk evidence synthesis note 0..* Annotation Used for footnotes or explanatory notes
useContext Σ 0..* UsageContext The context that the content is intended to support
jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for risk evidence synthesis (if applicable)
Jurisdiction (Extensible)
copyright 0..1 markdown Use and/or publishing restrictions approvalDate 0..1 date When the risk evidence synthesis was approved by publisher lastReviewDate 0..1 date When the risk evidence synthesis was last reviewed effectivePeriod Σ 0..1 Period When the risk evidence synthesis is expected to be used topic 0..* CodeableConcept The category of the EffectEvidenceSynthesis, such as Education, Treatment, Assessment, etc.
DefinitionTopic (Example)
author 0..* ContactDetail Who authored the content
editor 0..* ContactDetail Who edited the content
reviewer 0..* ContactDetail Who reviewed the content
endorser 0..* ContactDetail Who endorsed the content
relatedArtifact 0..* RelatedArtifact Additional documentation, citations, etc.
synthesisType 0..1 CodeableConcept Type of synthesis
SynthesisType (Extensible) studyType 0..1 CodeableConcept Type of study
StudyType (Extensible) population Σ 1..1 Reference(EvidenceVariable) What population? exposure Σ 0..1 Reference(EvidenceVariable) What exposure? outcome Σ 1..1 Reference(EvidenceVariable) What outcome? sampleSize 0..1 BackboneElement What sample size was involved? description 0..1 string Description of sample size numberOfStudies 0..1 integer How many studies? numberOfParticipants 0..1 integer How many participants? riskEstimate Σ 0..1 BackboneElement What was the estimated risk description 0..1 string Description of risk estimate type 0..1 CodeableConcept Type of risk estimate
RiskEstimateType (Extensible) value 0..1 decimal Point estimate unitOfMeasure 0..1 CodeableConcept What unit is the outcome described in?
UCUM Codes (Required) denominatorCount 0..1 integer Sample size for group measured numeratorCount 0..1 integer Number with the outcome precisionEstimate 0..* BackboneElement How precise the estimate is
type 0..1 CodeableConcept Type of precision estimate
PrecisionEstimateType (Extensible) level 0..1 decimal Level of confidence interval from 0..1 decimal Lower bound to 0..1 decimal Upper bound certainty 0..* BackboneElement How certain is the risk
rating 0..* CodeableConcept Certainty rating
QualityOfEvidenceRating (Extensible)
note 0..* Annotation Used for footnotes or explanatory notes
certaintySubcomponent 0..* BackboneElement A component that contributes to the overall certainty
type 0..1 CodeableConcept Type of subcomponent of certainty rating
CertaintySubcomponentType (Extensible) rating 0..* CodeableConcept Subcomponent certainty rating
CertaintySubcomponentRating (Extensible)
note 0..* Annotation Used for footnotes or explanatory notes
Documentation for this format
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Specialized.Evidence-Based Medicine"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 0
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "business"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "cds"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/RiskEvidenceSynthesis",
"version" : "4.0.1",
"name" : "RiskEvidenceSynthesis",
"status" : "draft",
"date" : "2019-11-01T09:29:23+11:00",
"publisher" : "Health Level Seven International (Clinical Decision Support)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/dss/index.cfm"
}]
}],
"description" : "The RiskEvidenceSynthesis resource describes the likelihood of an outcome in a population plus exposure state where the risk estimate is derived from a combination of research studies.",
"fhirVersion" : "4.0.1",
"mapping" : [{
"identity" : "workflow",
"uri" : "http://hl7.org/fhir/workflow",
"name" : "Workflow Pattern"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/fivews",
"name" : "FiveWs Pattern Mapping"
},
{
"identity" : "objimpl",
"uri" : "http://hl7.org/fhir/object-implementation",
"name" : "Object Implementation Information"
},
{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
}],
"kind" : "resource",
"abstract" : false,
"type" : "RiskEvidenceSynthesis",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"_baseDefinition" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-codegen-super",
"valueString" : "MetadataResource"
}]
},
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "RiskEvidenceSynthesis",
"path" : "RiskEvidenceSynthesis",
"short" : "A quantified estimate of risk based on a body of evidence",
"definition" : "The RiskEvidenceSynthesis resource describes the likelihood of an outcome in a population plus exposure state where the risk estimate is derived from a combination of research studies.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "RiskEvidenceSynthesis",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "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",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.`div`.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "rvs-0",
"severity" : "warning",
"human" : "Name should be usable as an identifier for the module by machine processing applications such as code generation",
"expression" : "name.matches('[A-Z]([A-Za-z0-9_]){0,254}')",
"xpath" : "not(exists(f:name/@value)) or matches(f:name/@value, '[A-Z]([A-Za-z0-9_]){0,254}')"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "workflow",
"map" : "Definition"
}]
},
{
"id" : "RiskEvidenceSynthesis.id",
"path" : "RiskEvidenceSynthesis.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "RiskEvidenceSynthesis.meta",
"path" : "RiskEvidenceSynthesis.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "RiskEvidenceSynthesis.implicitRules",
"path" : "RiskEvidenceSynthesis.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "RiskEvidenceSynthesis.language",
"path" : "RiskEvidenceSynthesis.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "RiskEvidenceSynthesis.text",
"path" : "RiskEvidenceSynthesis.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "RiskEvidenceSynthesis.contained",
"path" : "RiskEvidenceSynthesis.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "RiskEvidenceSynthesis.extension",
"path" : "RiskEvidenceSynthesis.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "RiskEvidenceSynthesis.modifierExtension",
"path" : "RiskEvidenceSynthesis.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "RiskEvidenceSynthesis.url",
"path" : "RiskEvidenceSynthesis.url",
"short" : "Canonical identifier for this risk evidence synthesis, represented as a URI (globally unique)",
"definition" : "An absolute URI that is used to identify this risk evidence synthesis when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this risk evidence synthesis is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the risk evidence synthesis is stored on different servers.",
"comment" : "Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.\n\nThe determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions). \n\nIn some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.",
"requirements" : "Allows the risk evidence synthesis to be referenced by a single globally unique identifier.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "RiskEvidenceSynthesis.url",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.url"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
}]
},
{
"id" : "RiskEvidenceSynthesis.identifier",
"path" : "RiskEvidenceSynthesis.identifier",
"short" : "Additional identifier for the risk evidence synthesis",
"definition" : "A formal identifier that is used to identify this risk evidence synthesis when it is represented in other formats, or referenced in a specification, model, design or an instance.",
"comment" : "Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this risk evidence synthesis outside of FHIR, where it is not possible to use the logical URI.",
"requirements" : "Allows externally provided and/or usable business identifiers to be easily associated with the module.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "RiskEvidenceSynthesis.identifier",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Identifier"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.identifier"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "RiskEvidenceSynthesis.version",
"path" : "RiskEvidenceSynthesis.version",
"short" : "Business version of the risk evidence synthesis",
"definition" : "The identifier that is used to identify this version of the risk evidence synthesis when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the risk evidence synthesis author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.",
"comment" : "There may be different risk evidence synthesis instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the risk evidence synthesis with the format [url]|[version].",
"min" : 0,
"max" : "1",
"base" : {
"path" : "RiskEvidenceSynthesis.version",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.version"
},
{
"identity" : "w5",
"map" : "FiveWs.version"
}]
},
{
"id" : "RiskEvidenceSynthesis.name",
"path" : "RiskEvidenceSynthesis.name",
"short" : "Name for this risk evidence synthesis (computer friendly)",
"definition" : "A natural language name identifying the risk evidence synthesis. This name should be usable as an identifier for the module by machine processing applications such as code generation.",
"comment" : "The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.",
"requirements" : "Support human navigation and code generation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "RiskEvidenceSynthesis.name",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"condition" : ["inv-0"],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "RiskEvidenceSynthesis.title",
"path" : "RiskEvidenceSynthesis.title",
"short" : "Name for this risk evidence synthesis (human friendly)",
"definition" : "A short, descriptive, user-friendly title for the risk evidence synthesis.",
"comment" : "This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "RiskEvidenceSynthesis.title",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.title"
}]
},
{
"id" : "RiskEvidenceSynthesis.status",
"path" : "RiskEvidenceSynthesis.status",
"short" : "draft | active | retired | unknown",
"definition" : "The status of this risk evidence synthesis. Enables tracking the life-cycle of the content.",
"comment" : "Allows filtering of risk evidence synthesiss that are appropriate for use versus not.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "RiskEvidenceSynthesis.status",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This is labeled as \"Is Modifier\" because applications should not use a retired {{title}} without due consideration",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "PublicationStatus"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "The lifecycle status of an artifact.",
"valueSet" : "http://hl7.org/fhir/ValueSet/publication-status|4.0.1"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.status"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
}]
},
{
"id" : "RiskEvidenceSynthesis.date",
"path" : "RiskEvidenceSynthesis.date",
"short" : "Date last changed",
"definition" : "The date (and optionally time) when the risk evidence synthesis was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the risk evidence synthesis changes.",
"comment" : "Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the risk evidence synthesis. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.",
"alias" : ["Revision Date"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "RiskEvidenceSynthesis.date",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.date"
},
{
"identity" : "w5",
"map" : "FiveWs.recorded"
}]
},
{
"id" : "RiskEvidenceSynthesis.publisher",
"path" : "RiskEvidenceSynthesis.publisher",
"short" : "Name of the publisher (organization or individual)",
"definition" : "The name of the organization or individual that published the risk evidence synthesis.",
"comment" : "Usually an organization but may be an individual. The publisher (or steward) of the risk evidence synthesis is the organization or individual primarily responsible for the maintenance and upkeep of the risk evidence synthesis. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the risk evidence synthesis. This item SHOULD be populated unless the information is available from context.",
"requirements" : "Helps establish the \"authority/credibility\" of the risk evidence synthesis. May also allow for contact.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "RiskEvidenceSynthesis.publisher",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.publisher"
},
{
"identity" : "w5",
"map" : "FiveWs.witness"
}]
},
{
"id" : "RiskEvidenceSynthesis.contact",
"path" : "RiskEvidenceSynthesis.contact",
"short" : "Contact details for the publisher",
"definition" : "Contact details to assist a user in finding and communicating with the publisher.",
"comment" : "May be a web site, an email address, a telephone number, etc.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "RiskEvidenceSynthesis.contact",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "ContactDetail"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.contact"
}]
},
{
"id" : "RiskEvidenceSynthesis.description",
"path" : "RiskEvidenceSynthesis.description",
"short" : "Natural language description of the risk evidence synthesis",
"definition" : "A free text natural language description of the risk evidence synthesis from a consumer's perspective.",
"comment" : "This description can be used to capture details such as why the risk evidence synthesis was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the risk evidence synthesis as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the risk evidence synthesis is presumed to be the predominant language in the place the risk evidence synthesis was created).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "RiskEvidenceSynthesis.description",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "markdown"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.description"
}]
},
{
"id" : "RiskEvidenceSynthesis.note",
"path" : "RiskEvidenceSynthesis.note",
"short" : "Used for footnotes or explanatory notes",
"definition" : "A human-readable string to clarify or explain concepts about the resource.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "RiskEvidenceSynthesis.note",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Annotation"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "RiskEvidenceSynthesis.useContext",
"path" : "RiskEvidenceSynthesis.useContext",
"short" : "The context that the content is intended to support",
"definition" : "The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate risk evidence synthesis instances.",
"comment" : "When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.",
"requirements" : "Assist in searching for appropriate content.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "RiskEvidenceSynthesis.useContext",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "UsageContext"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.useContext"
}]
},
{
"id" : "RiskEvidenceSynthesis.jurisdiction",
"path" : "RiskEvidenceSynthesis.jurisdiction",
"short" : "Intended jurisdiction for risk evidence synthesis (if applicable)",
"definition" : "A legal or geographic region in which the risk evidence synthesis is intended to be used.",
"comment" : "It may be possible for the risk evidence synthesis to be used in jurisdictions other than those for which it was originally designed or intended.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "RiskEvidenceSynthesis.jurisdiction",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Jurisdiction"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "extensible",
"description" : "Countries and regions within which this artifact is targeted for use.",
"valueSet" : "http://hl7.org/fhir/ValueSet/jurisdiction"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.jurisdiction"
}]
},
{
"id" : "RiskEvidenceSynthesis.copyright",
"path" : "RiskEvidenceSynthesis.copyright",
"short" : "Use and/or publishing restrictions",
"definition" : "A copyright statement relating to the risk evidence synthesis and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the risk evidence synthesis.",
"requirements" : "Consumers must be able to determine any legal restrictions on the use of the risk evidence synthesis and/or its content.",
"alias" : ["License",
"Restrictions"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "RiskEvidenceSynthesis.copyright",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "markdown"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.copyright"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "RiskEvidenceSynthesis.approvalDate",
"path" : "RiskEvidenceSynthesis.approvalDate",
"short" : "When the risk evidence synthesis was approved by publisher",
"definition" : "The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.",
"comment" : "The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "RiskEvidenceSynthesis.approvalDate",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "date"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.approvalDate"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "RiskEvidenceSynthesis.lastReviewDate",
"path" : "RiskEvidenceSynthesis.lastReviewDate",
"short" : "When the risk evidence synthesis was last reviewed",
"definition" : "The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.",
"comment" : "If specified, this date follows the original approval date.",
"requirements" : "Gives a sense of how \"current\" the content is. Resources that have not been reviewed in a long time may have a risk of being less appropriate/relevant.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "RiskEvidenceSynthesis.lastReviewDate",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "date"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.lastReviewDate"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "RiskEvidenceSynthesis.effectivePeriod",
"path" : "RiskEvidenceSynthesis.effectivePeriod",
"short" : "When the risk evidence synthesis is expected to be used",
"definition" : "The period during which the risk evidence synthesis content was or is planned to be in active use.",
"comment" : "The effective period for a risk evidence synthesis determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 might be published in 2015.",
"requirements" : "Allows establishing a transition before a resource comes into effect and also allows for a sunsetting process when new versions of the risk evidence synthesis are or are expected to be used instead.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "RiskEvidenceSynthesis.effectivePeriod",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Period"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.effectivePeriod"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "RiskEvidenceSynthesis.topic",
"path" : "RiskEvidenceSynthesis.topic",
"short" : "The category of the EffectEvidenceSynthesis, such as Education, Treatment, Assessment, etc.",
"definition" : "Descriptive topics related to the content of the RiskEvidenceSynthesis. Topics provide a high-level categorization grouping types of EffectEvidenceSynthesiss that can be useful for filtering and searching.",
"requirements" : "Repositories must be able to determine how to categorize the RiskEvidenceSynthesis so that it can be found by topical searches.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "RiskEvidenceSynthesis.topic",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "DefinitionTopic"
}],
"strength" : "example",
"description" : "High-level categorization of the definition, used for searching, sorting, and filtering.",
"valueSet" : "http://hl7.org/fhir/ValueSet/definition-topic"
}
},
{
"id" : "RiskEvidenceSynthesis.author",
"path" : "RiskEvidenceSynthesis.author",
"short" : "Who authored the content",
"definition" : "An individiual or organization primarily involved in the creation and maintenance of the content.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "RiskEvidenceSynthesis.author",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "ContactDetail"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".participation[typeCode=AUT]"
}]
},
{
"id" : "RiskEvidenceSynthesis.editor",
"path" : "RiskEvidenceSynthesis.editor",
"short" : "Who edited the content",
"definition" : "An individual or organization primarily responsible for internal coherence of the content.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "RiskEvidenceSynthesis.editor",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "ContactDetail"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "RiskEvidenceSynthesis.reviewer",
"path" : "RiskEvidenceSynthesis.reviewer",
"short" : "Who reviewed the content",
"definition" : "An individual or organization primarily responsible for review of some aspect of the content.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "RiskEvidenceSynthesis.reviewer",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "ContactDetail"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".participation[typeCode=VRF] {not clear whether VRF best corresponds to reviewer or endorser}"
}]
},
{
"id" : "RiskEvidenceSynthesis.endorser",
"path" : "RiskEvidenceSynthesis.endorser",
"short" : "Who endorsed the content",
"definition" : "An individual or organization responsible for officially endorsing the content for use in some setting.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "RiskEvidenceSynthesis.endorser",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "ContactDetail"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".participation[typeCode=VRF] {not clear whether VRF best corresponds to reviewer or endorser}"
}]
},
{
"id" : "RiskEvidenceSynthesis.relatedArtifact",
"path" : "RiskEvidenceSynthesis.relatedArtifact",
"short" : "Additional documentation, citations, etc.",
"definition" : "Related artifacts such as additional documentation, justification, or bibliographic references.",
"comment" : "Each related artifact is either an attachment, or a reference to another resource, but not both.",
"requirements" : "RiskEvidenceSynthesiss must be able to provide enough information for consumers of the content (and/or interventions or results produced by the content) to be able to determine and understand the justification for and evidence in support of the content.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "RiskEvidenceSynthesis.relatedArtifact",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "RelatedArtifact"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "RiskEvidenceSynthesis.synthesisType",
"path" : "RiskEvidenceSynthesis.synthesisType",
"short" : "Type of synthesis",
"definition" : "Type of synthesis eg meta-analysis.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "RiskEvidenceSynthesis.synthesisType",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SynthesisType"
}],
"strength" : "extensible",
"description" : "Types of combining results from a body of evidence (eg. summary data meta-analysis).",
"valueSet" : "http://hl7.org/fhir/ValueSet/synthesis-type"
}
},
{
"id" : "RiskEvidenceSynthesis.studyType",
"path" : "RiskEvidenceSynthesis.studyType",
"short" : "Type of study",
"definition" : "Type of study eg randomized trial.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "RiskEvidenceSynthesis.studyType",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "StudyType"
}],
"strength" : "extensible",
"description" : "Types of research studies (types of research methods).",
"valueSet" : "http://hl7.org/fhir/ValueSet/study-type"
}
},
{
"id" : "RiskEvidenceSynthesis.population",
"path" : "RiskEvidenceSynthesis.population",
"short" : "What population?",
"definition" : "A reference to a EvidenceVariable resource that defines the population for the research.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "RiskEvidenceSynthesis.population",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/EvidenceVariable"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "RiskEvidenceSynthesis.exposure",
"path" : "RiskEvidenceSynthesis.exposure",
"short" : "What exposure?",
"definition" : "A reference to a EvidenceVariable resource that defines the exposure for the research.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "RiskEvidenceSynthesis.exposure",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/EvidenceVariable"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "RiskEvidenceSynthesis.outcome",
"path" : "RiskEvidenceSynthesis.outcome",
"short" : "What outcome?",
"definition" : "A reference to a EvidenceVariable resomece that defines the outcome for the research.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "RiskEvidenceSynthesis.outcome",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/EvidenceVariable"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "RiskEvidenceSynthesis.sampleSize",
"path" : "RiskEvidenceSynthesis.sampleSize",
"short" : "What sample size was involved?",
"definition" : "A description of the size of the sample involved in the synthesis.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "RiskEvidenceSynthesis.sampleSize",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "RiskEvidenceSynthesis.sampleSize.id",
"path" : "RiskEvidenceSynthesis.sampleSize.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "RiskEvidenceSynthesis.sampleSize.extension",
"path" : "RiskEvidenceSynthesis.sampleSize.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "RiskEvidenceSynthesis.sampleSize.modifierExtension",
"path" : "RiskEvidenceSynthesis.sampleSize.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "RiskEvidenceSynthesis.sampleSize.description",
"path" : "RiskEvidenceSynthesis.sampleSize.description",
"short" : "Description of sample size",
"definition" : "Human-readable summary of sample size.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "RiskEvidenceSynthesis.sampleSize.description",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "RiskEvidenceSynthesis.sampleSize.numberOfStudies",
"path" : "RiskEvidenceSynthesis.sampleSize.numberOfStudies",
"short" : "How many studies?",
"definition" : "Number of studies included in this evidence synthesis.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "RiskEvidenceSynthesis.sampleSize.numberOfStudies",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "integer"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "RiskEvidenceSynthesis.sampleSize.numberOfParticipants",
"path" : "RiskEvidenceSynthesis.sampleSize.numberOfParticipants",
"short" : "How many participants?",
"definition" : "Number of participants included in this evidence synthesis.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "RiskEvidenceSynthesis.sampleSize.numberOfParticipants",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "integer"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "RiskEvidenceSynthesis.riskEstimate",
"path" : "RiskEvidenceSynthesis.riskEstimate",
"short" : "What was the estimated risk",
"definition" : "The estimated risk of the outcome.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "RiskEvidenceSynthesis.riskEstimate",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "RiskEvidenceSynthesis.riskEstimate.id",
"path" : "RiskEvidenceSynthesis.riskEstimate.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "RiskEvidenceSynthesis.riskEstimate.extension",
"path" : "RiskEvidenceSynthesis.riskEstimate.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "RiskEvidenceSynthesis.riskEstimate.modifierExtension",
"path" : "RiskEvidenceSynthesis.riskEstimate.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "RiskEvidenceSynthesis.riskEstimate.description",
"path" : "RiskEvidenceSynthesis.riskEstimate.description",
"short" : "Description of risk estimate",
"definition" : "Human-readable summary of risk estimate.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "RiskEvidenceSynthesis.riskEstimate.description",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "RiskEvidenceSynthesis.riskEstimate.type",
"path" : "RiskEvidenceSynthesis.riskEstimate.type",
"short" : "Type of risk estimate",
"definition" : "Examples include proportion and mean.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "RiskEvidenceSynthesis.riskEstimate.type",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "RiskEstimateType"
}],
"strength" : "extensible",
"description" : "Whether the risk estimate is dichotomous, continuous or qualitative and the specific type of risk estimate (eg proportion or median).",
"valueSet" : "http://hl7.org/fhir/ValueSet/risk-estimate-type"
}
},
{
"id" : "RiskEvidenceSynthesis.riskEstimate.value",
"path" : "RiskEvidenceSynthesis.riskEstimate.value",
"short" : "Point estimate",
"definition" : "The point estimate of the risk estimate.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "RiskEvidenceSynthesis.riskEstimate.value",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "decimal"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "RiskEvidenceSynthesis.riskEstimate.unitOfMeasure",
"path" : "RiskEvidenceSynthesis.riskEstimate.unitOfMeasure",
"short" : "What unit is the outcome described in?",
"definition" : "Specifies the UCUM unit for the outcome.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "RiskEvidenceSynthesis.riskEstimate.unitOfMeasure",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "UCUMUnits"
}],
"strength" : "required",
"description" : "Unified Code for Units of Measure (UCUM).",
"valueSet" : "http://hl7.org/fhir/ValueSet/ucum-units|4.0.1"
}
},
{
"id" : "RiskEvidenceSynthesis.riskEstimate.denominatorCount",
"path" : "RiskEvidenceSynthesis.riskEstimate.denominatorCount",
"short" : "Sample size for group measured",
"definition" : "The sample size for the group that was measured for this risk estimate.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "RiskEvidenceSynthesis.riskEstimate.denominatorCount",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "integer"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "RiskEvidenceSynthesis.riskEstimate.numeratorCount",
"path" : "RiskEvidenceSynthesis.riskEstimate.numeratorCount",
"short" : "Number with the outcome",
"definition" : "The number of group members with the outcome of interest.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "RiskEvidenceSynthesis.riskEstimate.numeratorCount",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "integer"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "RiskEvidenceSynthesis.riskEstimate.precisionEstimate",
"path" : "RiskEvidenceSynthesis.riskEstimate.precisionEstimate",
"short" : "How precise the estimate is",
"definition" : "A description of the precision of the estimate for the effect.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "RiskEvidenceSynthesis.riskEstimate.precisionEstimate",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "RiskEvidenceSynthesis.riskEstimate.precisionEstimate.id",
"path" : "RiskEvidenceSynthesis.riskEstimate.precisionEstimate.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "RiskEvidenceSynthesis.riskEstimate.precisionEstimate.extension",
"path" : "RiskEvidenceSynthesis.riskEstimate.precisionEstimate.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "RiskEvidenceSynthesis.riskEstimate.precisionEstimate.modifierExtension",
"path" : "RiskEvidenceSynthesis.riskEstimate.precisionEstimate.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "RiskEvidenceSynthesis.riskEstimate.precisionEstimate.type",
"path" : "RiskEvidenceSynthesis.riskEstimate.precisionEstimate.type",
"short" : "Type of precision estimate",
"definition" : "Examples include confidence interval and interquartile range.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "RiskEvidenceSynthesis.riskEstimate.precisionEstimate.type",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "PrecisionEstimateType"
}],
"strength" : "extensible",
"description" : "Method of reporting variability of estimates, such as confidence intervals, interquartile range or standard deviation.",
"valueSet" : "http://hl7.org/fhir/ValueSet/precision-estimate-type"
}
},
{
"id" : "RiskEvidenceSynthesis.riskEstimate.precisionEstimate.level",
"path" : "RiskEvidenceSynthesis.riskEstimate.precisionEstimate.level",
"short" : "Level of confidence interval",
"definition" : "Use 95 for a 95% confidence interval.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "RiskEvidenceSynthesis.riskEstimate.precisionEstimate.level",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "decimal"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "RiskEvidenceSynthesis.riskEstimate.precisionEstimate.from",
"path" : "RiskEvidenceSynthesis.riskEstimate.precisionEstimate.from",
"short" : "Lower bound",
"definition" : "Lower bound of confidence interval.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "RiskEvidenceSynthesis.riskEstimate.precisionEstimate.from",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "decimal"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "RiskEvidenceSynthesis.riskEstimate.precisionEstimate.to",
"path" : "RiskEvidenceSynthesis.riskEstimate.precisionEstimate.to",
"short" : "Upper bound",
"definition" : "Upper bound of confidence interval.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "RiskEvidenceSynthesis.riskEstimate.precisionEstimate.to",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "decimal"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "RiskEvidenceSynthesis.certainty",
"path" : "RiskEvidenceSynthesis.certainty",
"short" : "How certain is the risk",
"definition" : "A description of the certainty of the risk estimate.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "RiskEvidenceSynthesis.certainty",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "RiskEvidenceSynthesis.certainty.id",
"path" : "RiskEvidenceSynthesis.certainty.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "RiskEvidenceSynthesis.certainty.extension",
"path" : "RiskEvidenceSynthesis.certainty.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "RiskEvidenceSynthesis.certainty.modifierExtension",
"path" : "RiskEvidenceSynthesis.certainty.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "RiskEvidenceSynthesis.certainty.rating",
"path" : "RiskEvidenceSynthesis.certainty.rating",
"short" : "Certainty rating",
"definition" : "A rating of the certainty of the effect estimate.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "RiskEvidenceSynthesis.certainty.rating",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "QualityOfEvidenceRating"
}],
"strength" : "extensible",
"description" : "The quality of the evidence described. The code system used specifies the quality scale used to grade this evidence source while the code specifies the actual quality score (represented as a coded value) associated with the evidence.",
"valueSet" : "http://hl7.org/fhir/ValueSet/evidence-quality"
}
},
{
"id" : "RiskEvidenceSynthesis.certainty.note",
"path" : "RiskEvidenceSynthesis.certainty.note",
"short" : "Used for footnotes or explanatory notes",
"definition" : "A human-readable string to clarify or explain concepts about the resource.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "RiskEvidenceSynthesis.certainty.note",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Annotation"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "RiskEvidenceSynthesis.certainty.certaintySubcomponent",
"path" : "RiskEvidenceSynthesis.certainty.certaintySubcomponent",
"short" : "A component that contributes to the overall certainty",
"definition" : "A description of a component of the overall certainty.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "RiskEvidenceSynthesis.certainty.certaintySubcomponent",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "RiskEvidenceSynthesis.certainty.certaintySubcomponent.id",
"path" : "RiskEvidenceSynthesis.certainty.certaintySubcomponent.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "RiskEvidenceSynthesis.certainty.certaintySubcomponent.extension",
"path" : "RiskEvidenceSynthesis.certainty.certaintySubcomponent.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "RiskEvidenceSynthesis.certainty.certaintySubcomponent.modifierExtension",
"path" : "RiskEvidenceSynthesis.certainty.certaintySubcomponent.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "RiskEvidenceSynthesis.certainty.certaintySubcomponent.type",
"path" : "RiskEvidenceSynthesis.certainty.certaintySubcomponent.type",
"short" : "Type of subcomponent of certainty rating",
"definition" : "Type of subcomponent of certainty rating.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "RiskEvidenceSynthesis.certainty.certaintySubcomponent.type",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "CertaintySubcomponentType"
}],
"strength" : "extensible",
"description" : "The subcomponent classification of quality of evidence rating systems.",
"valueSet" : "http://hl7.org/fhir/ValueSet/certainty-subcomponent-type"
}
},
{
"id" : "RiskEvidenceSynthesis.certainty.certaintySubcomponent.rating",
"path" : "RiskEvidenceSynthesis.certainty.certaintySubcomponent.rating",
"short" : "Subcomponent certainty rating",
"definition" : "A rating of a subcomponent of rating certainty.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "RiskEvidenceSynthesis.certainty.certaintySubcomponent.rating",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "CertaintySubcomponentRating"
}],
"strength" : "extensible",
"description" : "The quality rating of the subcomponent of a quality of evidence rating.",
"valueSet" : "http://hl7.org/fhir/ValueSet/certainty-subcomponent-rating"
}
},
{
"id" : "RiskEvidenceSynthesis.certainty.certaintySubcomponent.note",
"path" : "RiskEvidenceSynthesis.certainty.certaintySubcomponent.note",
"short" : "Used for footnotes or explanatory notes",
"definition" : "A human-readable string to clarify or explain concepts about the resource.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "RiskEvidenceSynthesis.certainty.certaintySubcomponent.note",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Annotation"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
}]
},
"differential" : {
"element" : [{
"id" : "RiskEvidenceSynthesis",
"path" : "RiskEvidenceSynthesis",
"short" : "A quantified estimate of risk based on a body of evidence",
"definition" : "The RiskEvidenceSynthesis resource describes the likelihood of an outcome in a population plus exposure state where the risk estimate is derived from a combination of research studies.",
"min" : 0,
"max" : "*",
"constraint" : [{
"key" : "rvs-0",
"severity" : "warning",
"human" : "Name should be usable as an identifier for the module by machine processing applications such as code generation",
"expression" : "name.matches('[A-Z]([A-Za-z0-9_]){0,254}')",
"xpath" : "not(exists(f:name/@value)) or matches(f:name/@value, '[A-Z]([A-Za-z0-9_]){0,254}')"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Definition"
}]
},
{
"id" : "RiskEvidenceSynthesis.url",
"path" : "RiskEvidenceSynthesis.url",
"short" : "Canonical identifier for this risk evidence synthesis, represented as a URI (globally unique)",
"definition" : "An absolute URI that is used to identify this risk evidence synthesis when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this risk evidence synthesis is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the risk evidence synthesis is stored on different servers.",
"comment" : "Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.\n\nThe determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions). \n\nIn some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.",
"requirements" : "Allows the risk evidence synthesis to be referenced by a single globally unique identifier.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "uri"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.url"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
}]
},
{
"id" : "RiskEvidenceSynthesis.identifier",
"path" : "RiskEvidenceSynthesis.identifier",
"short" : "Additional identifier for the risk evidence synthesis",
"definition" : "A formal identifier that is used to identify this risk evidence synthesis when it is represented in other formats, or referenced in a specification, model, design or an instance.",
"comment" : "Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this risk evidence synthesis outside of FHIR, where it is not possible to use the logical URI.",
"requirements" : "Allows externally provided and/or usable business identifiers to be easily associated with the module.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Identifier"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.identifier"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "RiskEvidenceSynthesis.version",
"path" : "RiskEvidenceSynthesis.version",
"short" : "Business version of the risk evidence synthesis",
"definition" : "The identifier that is used to identify this version of the risk evidence synthesis when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the risk evidence synthesis author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.",
"comment" : "There may be different risk evidence synthesis instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the risk evidence synthesis with the format [url]|[version].",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.version"
},
{
"identity" : "w5",
"map" : "FiveWs.version"
}]
},
{
"id" : "RiskEvidenceSynthesis.name",
"path" : "RiskEvidenceSynthesis.name",
"short" : "Name for this risk evidence synthesis (computer friendly)",
"definition" : "A natural language name identifying the risk evidence synthesis. This name should be usable as an identifier for the module by machine processing applications such as code generation.",
"comment" : "The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.",
"requirements" : "Support human navigation and code generation.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"condition" : ["inv-0"],
"isSummary" : true
},
{
"id" : "RiskEvidenceSynthesis.title",
"path" : "RiskEvidenceSynthesis.title",
"short" : "Name for this risk evidence synthesis (human friendly)",
"definition" : "A short, descriptive, user-friendly title for the risk evidence synthesis.",
"comment" : "This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.title"
}]
},
{
"id" : "RiskEvidenceSynthesis.status",
"path" : "RiskEvidenceSynthesis.status",
"short" : "draft | active | retired | unknown",
"definition" : "The status of this risk evidence synthesis. Enables tracking the life-cycle of the content.",
"comment" : "Allows filtering of risk evidence synthesiss that are appropriate for use versus not.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isModifier" : true,
"isModifierReason" : "This is labeled as \"Is Modifier\" because applications should not use a retired {{title}} without due consideration",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "PublicationStatus"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "The lifecycle status of an artifact.",
"valueSet" : "http://hl7.org/fhir/ValueSet/publication-status|4.0.1"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.status"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
}]
},
{
"id" : "RiskEvidenceSynthesis.date",
"path" : "RiskEvidenceSynthesis.date",
"short" : "Date last changed",
"definition" : "The date (and optionally time) when the risk evidence synthesis was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the risk evidence synthesis changes.",
"comment" : "Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the risk evidence synthesis. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.",
"alias" : ["Revision Date"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "dateTime"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.date"
},
{
"identity" : "w5",
"map" : "FiveWs.recorded"
}]
},
{
"id" : "RiskEvidenceSynthesis.publisher",
"path" : "RiskEvidenceSynthesis.publisher",
"short" : "Name of the publisher (organization or individual)",
"definition" : "The name of the organization or individual that published the risk evidence synthesis.",
"comment" : "Usually an organization but may be an individual. The publisher (or steward) of the risk evidence synthesis is the organization or individual primarily responsible for the maintenance and upkeep of the risk evidence synthesis. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the risk evidence synthesis. This item SHOULD be populated unless the information is available from context.",
"requirements" : "Helps establish the \"authority/credibility\" of the risk evidence synthesis. May also allow for contact.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.publisher"
},
{
"identity" : "w5",
"map" : "FiveWs.witness"
}]
},
{
"id" : "RiskEvidenceSynthesis.contact",
"path" : "RiskEvidenceSynthesis.contact",
"short" : "Contact details for the publisher",
"definition" : "Contact details to assist a user in finding and communicating with the publisher.",
"comment" : "May be a web site, an email address, a telephone number, etc.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "ContactDetail"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.contact"
}]
},
{
"id" : "RiskEvidenceSynthesis.description",
"path" : "RiskEvidenceSynthesis.description",
"short" : "Natural language description of the risk evidence synthesis",
"definition" : "A free text natural language description of the risk evidence synthesis from a consumer's perspective.",
"comment" : "This description can be used to capture details such as why the risk evidence synthesis was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the risk evidence synthesis as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the risk evidence synthesis is presumed to be the predominant language in the place the risk evidence synthesis was created).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "markdown"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.description"
}]
},
{
"id" : "RiskEvidenceSynthesis.note",
"path" : "RiskEvidenceSynthesis.note",
"short" : "Used for footnotes or explanatory notes",
"definition" : "A human-readable string to clarify or explain concepts about the resource.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Annotation"
}]
},
{
"id" : "RiskEvidenceSynthesis.useContext",
"path" : "RiskEvidenceSynthesis.useContext",
"short" : "The context that the content is intended to support",
"definition" : "The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate risk evidence synthesis instances.",
"comment" : "When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.",
"requirements" : "Assist in searching for appropriate content.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "UsageContext"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.useContext"
}]
},
{
"id" : "RiskEvidenceSynthesis.jurisdiction",
"path" : "RiskEvidenceSynthesis.jurisdiction",
"short" : "Intended jurisdiction for risk evidence synthesis (if applicable)",
"definition" : "A legal or geographic region in which the risk evidence synthesis is intended to be used.",
"comment" : "It may be possible for the risk evidence synthesis to be used in jurisdictions other than those for which it was originally designed or intended.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Jurisdiction"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "extensible",
"description" : "Countries and regions within which this artifact is targeted for use.",
"valueSet" : "http://hl7.org/fhir/ValueSet/jurisdiction"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.jurisdiction"
}]
},
{
"id" : "RiskEvidenceSynthesis.copyright",
"path" : "RiskEvidenceSynthesis.copyright",
"short" : "Use and/or publishing restrictions",
"definition" : "A copyright statement relating to the risk evidence synthesis and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the risk evidence synthesis.",
"requirements" : "Consumers must be able to determine any legal restrictions on the use of the risk evidence synthesis and/or its content.",
"alias" : ["License",
"Restrictions"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "markdown"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.copyright"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "RiskEvidenceSynthesis.approvalDate",
"path" : "RiskEvidenceSynthesis.approvalDate",
"short" : "When the risk evidence synthesis was approved by publisher",
"definition" : "The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.",
"comment" : "The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "date"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.approvalDate"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "RiskEvidenceSynthesis.lastReviewDate",
"path" : "RiskEvidenceSynthesis.lastReviewDate",
"short" : "When the risk evidence synthesis was last reviewed",
"definition" : "The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.",
"comment" : "If specified, this date follows the original approval date.",
"requirements" : "Gives a sense of how \"current\" the content is. Resources that have not been reviewed in a long time may have a risk of being less appropriate/relevant.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "date"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.lastReviewDate"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "RiskEvidenceSynthesis.effectivePeriod",
"path" : "RiskEvidenceSynthesis.effectivePeriod",
"short" : "When the risk evidence synthesis is expected to be used",
"definition" : "The period during which the risk evidence synthesis content was or is planned to be in active use.",
"comment" : "The effective period for a risk evidence synthesis determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 might be published in 2015.",
"requirements" : "Allows establishing a transition before a resource comes into effect and also allows for a sunsetting process when new versions of the risk evidence synthesis are or are expected to be used instead.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Period"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.effectivePeriod"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "RiskEvidenceSynthesis.topic",
"path" : "RiskEvidenceSynthesis.topic",
"short" : "The category of the EffectEvidenceSynthesis, such as Education, Treatment, Assessment, etc.",
"definition" : "Descriptive topics related to the content of the RiskEvidenceSynthesis. Topics provide a high-level categorization grouping types of EffectEvidenceSynthesiss that can be useful for filtering and searching.",
"requirements" : "Repositories must be able to determine how to categorize the RiskEvidenceSynthesis so that it can be found by topical searches.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "DefinitionTopic"
}],
"strength" : "example",
"description" : "High-level categorization of the definition, used for searching, sorting, and filtering.",
"valueSet" : "http://hl7.org/fhir/ValueSet/definition-topic"
}
},
{
"id" : "RiskEvidenceSynthesis.author",
"path" : "RiskEvidenceSynthesis.author",
"short" : "Who authored the content",
"definition" : "An individiual or organization primarily involved in the creation and maintenance of the content.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "ContactDetail"
}],
"mapping" : [{
"identity" : "rim",
"map" : ".participation[typeCode=AUT]"
}]
},
{
"id" : "RiskEvidenceSynthesis.editor",
"path" : "RiskEvidenceSynthesis.editor",
"short" : "Who edited the content",
"definition" : "An individual or organization primarily responsible for internal coherence of the content.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "ContactDetail"
}]
},
{
"id" : "RiskEvidenceSynthesis.reviewer",
"path" : "RiskEvidenceSynthesis.reviewer",
"short" : "Who reviewed the content",
"definition" : "An individual or organization primarily responsible for review of some aspect of the content.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "ContactDetail"
}],
"mapping" : [{
"identity" : "rim",
"map" : ".participation[typeCode=VRF] {not clear whether VRF best corresponds to reviewer or endorser}"
}]
},
{
"id" : "RiskEvidenceSynthesis.endorser",
"path" : "RiskEvidenceSynthesis.endorser",
"short" : "Who endorsed the content",
"definition" : "An individual or organization responsible for officially endorsing the content for use in some setting.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "ContactDetail"
}],
"mapping" : [{
"identity" : "rim",
"map" : ".participation[typeCode=VRF] {not clear whether VRF best corresponds to reviewer or endorser}"
}]
},
{
"id" : "RiskEvidenceSynthesis.relatedArtifact",
"path" : "RiskEvidenceSynthesis.relatedArtifact",
"short" : "Additional documentation, citations, etc.",
"definition" : "Related artifacts such as additional documentation, justification, or bibliographic references.",
"comment" : "Each related artifact is either an attachment, or a reference to another resource, but not both.",
"requirements" : "RiskEvidenceSynthesiss must be able to provide enough information for consumers of the content (and/or interventions or results produced by the content) to be able to determine and understand the justification for and evidence in support of the content.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "RelatedArtifact"
}]
},
{
"id" : "RiskEvidenceSynthesis.synthesisType",
"path" : "RiskEvidenceSynthesis.synthesisType",
"short" : "Type of synthesis",
"definition" : "Type of synthesis eg meta-analysis.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SynthesisType"
}],
"strength" : "extensible",
"description" : "Types of combining results from a body of evidence (eg. summary data meta-analysis).",
"valueSet" : "http://hl7.org/fhir/ValueSet/synthesis-type"
}
},
{
"id" : "RiskEvidenceSynthesis.studyType",
"path" : "RiskEvidenceSynthesis.studyType",
"short" : "Type of study",
"definition" : "Type of study eg randomized trial.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "StudyType"
}],
"strength" : "extensible",
"description" : "Types of research studies (types of research methods).",
"valueSet" : "http://hl7.org/fhir/ValueSet/study-type"
}
},
{
"id" : "RiskEvidenceSynthesis.population",
"path" : "RiskEvidenceSynthesis.population",
"short" : "What population?",
"definition" : "A reference to a EvidenceVariable resource that defines the population for the research.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/EvidenceVariable"]
}],
"isSummary" : true
},
{
"id" : "RiskEvidenceSynthesis.exposure",
"path" : "RiskEvidenceSynthesis.exposure",
"short" : "What exposure?",
"definition" : "A reference to a EvidenceVariable resource that defines the exposure for the research.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/EvidenceVariable"]
}],
"isSummary" : true
},
{
"id" : "RiskEvidenceSynthesis.outcome",
"path" : "RiskEvidenceSynthesis.outcome",
"short" : "What outcome?",
"definition" : "A reference to a EvidenceVariable resomece that defines the outcome for the research.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/EvidenceVariable"]
}],
"isSummary" : true
},
{
"id" : "RiskEvidenceSynthesis.sampleSize",
"path" : "RiskEvidenceSynthesis.sampleSize",
"short" : "What sample size was involved?",
"definition" : "A description of the size of the sample involved in the synthesis.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "RiskEvidenceSynthesis.sampleSize.description",
"path" : "RiskEvidenceSynthesis.sampleSize.description",
"short" : "Description of sample size",
"definition" : "Human-readable summary of sample size.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}]
},
{
"id" : "RiskEvidenceSynthesis.sampleSize.numberOfStudies",
"path" : "RiskEvidenceSynthesis.sampleSize.numberOfStudies",
"short" : "How many studies?",
"definition" : "Number of studies included in this evidence synthesis.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "integer"
}]
},
{
"id" : "RiskEvidenceSynthesis.sampleSize.numberOfParticipants",
"path" : "RiskEvidenceSynthesis.sampleSize.numberOfParticipants",
"short" : "How many participants?",
"definition" : "Number of participants included in this evidence synthesis.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "integer"
}]
},
{
"id" : "RiskEvidenceSynthesis.riskEstimate",
"path" : "RiskEvidenceSynthesis.riskEstimate",
"short" : "What was the estimated risk",
"definition" : "The estimated risk of the outcome.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "BackboneElement"
}],
"isSummary" : true
},
{
"id" : "RiskEvidenceSynthesis.riskEstimate.description",
"path" : "RiskEvidenceSynthesis.riskEstimate.description",
"short" : "Description of risk estimate",
"definition" : "Human-readable summary of risk estimate.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}]
},
{
"id" : "RiskEvidenceSynthesis.riskEstimate.type",
"path" : "RiskEvidenceSynthesis.riskEstimate.type",
"short" : "Type of risk estimate",
"definition" : "Examples include proportion and mean.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "RiskEstimateType"
}],
"strength" : "extensible",
"description" : "Whether the risk estimate is dichotomous, continuous or qualitative and the specific type of risk estimate (eg proportion or median).",
"valueSet" : "http://hl7.org/fhir/ValueSet/risk-estimate-type"
}
},
{
"id" : "RiskEvidenceSynthesis.riskEstimate.value",
"path" : "RiskEvidenceSynthesis.riskEstimate.value",
"short" : "Point estimate",
"definition" : "The point estimate of the risk estimate.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "decimal"
}]
},
{
"id" : "RiskEvidenceSynthesis.riskEstimate.unitOfMeasure",
"path" : "RiskEvidenceSynthesis.riskEstimate.unitOfMeasure",
"short" : "What unit is the outcome described in?",
"definition" : "Specifies the UCUM unit for the outcome.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "UCUMUnits"
}],
"strength" : "required",
"description" : "Unified Code for Units of Measure (UCUM).",
"valueSet" : "http://hl7.org/fhir/ValueSet/ucum-units|4.0.1"
}
},
{
"id" : "RiskEvidenceSynthesis.riskEstimate.denominatorCount",
"path" : "RiskEvidenceSynthesis.riskEstimate.denominatorCount",
"short" : "Sample size for group measured",
"definition" : "The sample size for the group that was measured for this risk estimate.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "integer"
}]
},
{
"id" : "RiskEvidenceSynthesis.riskEstimate.numeratorCount",
"path" : "RiskEvidenceSynthesis.riskEstimate.numeratorCount",
"short" : "Number with the outcome",
"definition" : "The number of group members with the outcome of interest.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "integer"
}]
},
{
"id" : "RiskEvidenceSynthesis.riskEstimate.precisionEstimate",
"path" : "RiskEvidenceSynthesis.riskEstimate.precisionEstimate",
"short" : "How precise the estimate is",
"definition" : "A description of the precision of the estimate for the effect.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "RiskEvidenceSynthesis.riskEstimate.precisionEstimate.type",
"path" : "RiskEvidenceSynthesis.riskEstimate.precisionEstimate.type",
"short" : "Type of precision estimate",
"definition" : "Examples include confidence interval and interquartile range.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "PrecisionEstimateType"
}],
"strength" : "extensible",
"description" : "Method of reporting variability of estimates, such as confidence intervals, interquartile range or standard deviation.",
"valueSet" : "http://hl7.org/fhir/ValueSet/precision-estimate-type"
}
},
{
"id" : "RiskEvidenceSynthesis.riskEstimate.precisionEstimate.level",
"path" : "RiskEvidenceSynthesis.riskEstimate.precisionEstimate.level",
"short" : "Level of confidence interval",
"definition" : "Use 95 for a 95% confidence interval.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "decimal"
}]
},
{
"id" : "RiskEvidenceSynthesis.riskEstimate.precisionEstimate.from",
"path" : "RiskEvidenceSynthesis.riskEstimate.precisionEstimate.from",
"short" : "Lower bound",
"definition" : "Lower bound of confidence interval.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "decimal"
}]
},
{
"id" : "RiskEvidenceSynthesis.riskEstimate.precisionEstimate.to",
"path" : "RiskEvidenceSynthesis.riskEstimate.precisionEstimate.to",
"short" : "Upper bound",
"definition" : "Upper bound of confidence interval.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "decimal"
}]
},
{
"id" : "RiskEvidenceSynthesis.certainty",
"path" : "RiskEvidenceSynthesis.certainty",
"short" : "How certain is the risk",
"definition" : "A description of the certainty of the risk estimate.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "RiskEvidenceSynthesis.certainty.rating",
"path" : "RiskEvidenceSynthesis.certainty.rating",
"short" : "Certainty rating",
"definition" : "A rating of the certainty of the effect estimate.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "QualityOfEvidenceRating"
}],
"strength" : "extensible",
"description" : "The quality of the evidence described. The code system used specifies the quality scale used to grade this evidence source while the code specifies the actual quality score (represented as a coded value) associated with the evidence.",
"valueSet" : "http://hl7.org/fhir/ValueSet/evidence-quality"
}
},
{
"id" : "RiskEvidenceSynthesis.certainty.note",
"path" : "RiskEvidenceSynthesis.certainty.note",
"short" : "Used for footnotes or explanatory notes",
"definition" : "A human-readable string to clarify or explain concepts about the resource.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Annotation"
}]
},
{
"id" : "RiskEvidenceSynthesis.certainty.certaintySubcomponent",
"path" : "RiskEvidenceSynthesis.certainty.certaintySubcomponent",
"short" : "A component that contributes to the overall certainty",
"definition" : "A description of a component of the overall certainty.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "RiskEvidenceSynthesis.certainty.certaintySubcomponent.type",
"path" : "RiskEvidenceSynthesis.certainty.certaintySubcomponent.type",
"short" : "Type of subcomponent of certainty rating",
"definition" : "Type of subcomponent of certainty rating.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "CertaintySubcomponentType"
}],
"strength" : "extensible",
"description" : "The subcomponent classification of quality of evidence rating systems.",
"valueSet" : "http://hl7.org/fhir/ValueSet/certainty-subcomponent-type"
}
},
{
"id" : "RiskEvidenceSynthesis.certainty.certaintySubcomponent.rating",
"path" : "RiskEvidenceSynthesis.certainty.certaintySubcomponent.rating",
"short" : "Subcomponent certainty rating",
"definition" : "A rating of a subcomponent of rating certainty.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "CertaintySubcomponentRating"
}],
"strength" : "extensible",
"description" : "The quality rating of the subcomponent of a quality of evidence rating.",
"valueSet" : "http://hl7.org/fhir/ValueSet/certainty-subcomponent-rating"
}
},
{
"id" : "RiskEvidenceSynthesis.certainty.certaintySubcomponent.note",
"path" : "RiskEvidenceSynthesis.certainty.certaintySubcomponent.note",
"short" : "Used for footnotes or explanatory notes",
"definition" : "A human-readable string to clarify or explain concepts about the resource.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Annotation"
}]
}]
}
}
},
{
"fullUrl" : "http://hl7.org/fhir/StructureDefinition/Schedule",
"resource" : {
"resourceType" : "StructureDefinition",
"id" : "Schedule",
"meta" : {
"lastUpdated" : "2019-11-01T09:29:23.356+11:00"
},
"text" : {
"status" : "generated",
"div" : "Name Flags Card. Type Description & Constraints Schedule 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 identifier Σ 0..* Identifier External Ids for this item
active ?!Σ 0..1 boolean Whether this schedule is in active use serviceCategory Σ 0..* CodeableConcept High-level category
Service category (Example)
serviceType Σ 0..* CodeableConcept Specific service
Service type (Example)
specialty Σ 0..* CodeableConcept Type of specialty needed
Practice Setting Code Value Set (Preferred)
actor Σ 1..* Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location) Resource(s) that availability information is being provided for
planningHorizon Σ 0..1 Period Period of time covered by schedule comment 0..1 string Comments on availability
Documentation for this format
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Base.Workflow"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 3
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "business"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "pa"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/Schedule",
"version" : "4.0.1",
"name" : "Schedule",
"status" : "draft",
"date" : "2019-11-01T09:29:23+11:00",
"publisher" : "Health Level Seven International (Patient Administration)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/pafm/index.cfm"
}]
}],
"description" : "A container for slots of time that may be available for booking appointments.",
"fhirVersion" : "4.0.1",
"mapping" : [{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
},
{
"identity" : "ical",
"uri" : "http://ietf.org/rfc/2445",
"name" : "iCalendar"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/fivews",
"name" : "FiveWs Pattern Mapping"
}],
"kind" : "resource",
"abstract" : false,
"type" : "Schedule",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "Schedule",
"path" : "Schedule",
"short" : "A container for slots of time that may be available for booking appointments",
"definition" : "A container for slots of time that may be available for booking appointments.",
"alias" : ["Availability"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Schedule",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "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",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.`div`.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "ical",
"map" : "BEGIN:VFREEBUSY ??? END:VFREEBUSY (If your fhir server provides this information via calDAV, then you may want to include addressing information in a URL section, and with the search, a DTSTART and DTEND component can be included to indicate the range of time that has been covered in the collection of slots, where these overlap the resources period values. For all slots that reference this resource, include a FREEBUSY row for each slot)"
}]
},
{
"id" : "Schedule.id",
"path" : "Schedule.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Schedule.meta",
"path" : "Schedule.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Schedule.implicitRules",
"path" : "Schedule.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "Schedule.language",
"path" : "Schedule.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "Schedule.text",
"path" : "Schedule.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "Schedule.contained",
"path" : "Schedule.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Schedule.extension",
"path" : "Schedule.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Schedule.modifierExtension",
"path" : "Schedule.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Schedule.identifier",
"path" : "Schedule.identifier",
"short" : "External Ids for this item",
"definition" : "External Ids for this item.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Schedule.identifier",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Identifier"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "ical",
"map" : "UID"
}]
},
{
"id" : "Schedule.active",
"path" : "Schedule.active",
"short" : "Whether this schedule is in active use",
"definition" : "Whether this schedule record is in active use or should not be used (such as was entered in error).",
"comment" : "This element is labeled as a modifier because it may be used to mark that the resource was created in error.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Schedule.active",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"meaningWhenMissing" : "This resource is generally assumed to be active if no value is provided for the active element",
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid",
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.status"
}]
},
{
"id" : "Schedule.serviceCategory",
"path" : "Schedule.serviceCategory",
"short" : "High-level category",
"definition" : "A broad categorization of the service that is to be performed during this appointment.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Schedule.serviceCategory",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "service-category"
}],
"strength" : "example",
"valueSet" : "http://hl7.org/fhir/ValueSet/service-category"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.class"
}]
},
{
"id" : "Schedule.serviceType",
"path" : "Schedule.serviceType",
"short" : "Specific service",
"definition" : "The specific service that is to be performed during this appointment.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Schedule.serviceType",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "service-type"
}],
"strength" : "example",
"valueSet" : "http://hl7.org/fhir/ValueSet/service-type"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.class"
},
{
"identity" : "ical",
"map" : "n/a"
}]
},
{
"id" : "Schedule.specialty",
"path" : "Schedule.specialty",
"short" : "Type of specialty needed",
"definition" : "The specialty of a practitioner that would be required to perform the service requested in this appointment.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Schedule.specialty",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "specialty"
}],
"strength" : "preferred",
"description" : "Additional details about where the content was created (e.g. clinical specialty).",
"valueSet" : "http://hl7.org/fhir/ValueSet/c80-practice-codes"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.class"
}]
},
{
"id" : "Schedule.actor",
"path" : "Schedule.actor",
"short" : "Resource(s) that availability information is being provided for",
"definition" : "Slots that reference this schedule resource provide the availability details to these referenced resource(s).",
"comment" : "The capacity to support multiple referenced resource types should be used in cases where the specific resources themselves cannot be scheduled without the other, and thus only make sense to the system exposing them as a group. Common examples of this are where the combination of a practitioner and a room (Location) are always required by a system.",
"min" : 1,
"max" : "*",
"base" : {
"path" : "Schedule.actor",
"min" : 1,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson",
"http://hl7.org/fhir/StructureDefinition/Device",
"http://hl7.org/fhir/StructureDefinition/HealthcareService",
"http://hl7.org/fhir/StructureDefinition/Location"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.subject[x]"
},
{
"identity" : "ical",
"map" : "ATTENDEE:MAILTO:john_public@host2.com This can be populated with a value from the referenced resource"
},
{
"identity" : "w5",
"map" : "FiveWs.subject"
}]
},
{
"id" : "Schedule.planningHorizon",
"path" : "Schedule.planningHorizon",
"short" : "Period of time covered by schedule",
"definition" : "The period of time that the slots that reference this Schedule resource cover (even if none exist). These cover the amount of time that an organization's planning horizon; the interval for which they are currently accepting appointments. This does not define a \"template\" for planning outside these dates.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Schedule.planningHorizon",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Period"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.planned"
},
{
"identity" : "ical",
"map" : "DTSTART:20131201T003000Z DTEND:2014030101T003000Z"
}]
},
{
"id" : "Schedule.comment",
"path" : "Schedule.comment",
"short" : "Comments on availability",
"definition" : "Comments on the availability to describe any extended information. Such as custom constraints on the slots that may be associated.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Schedule.comment",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "ical",
"map" : "COMMENT:(comment) If there is no comment, then the line can be excluded from the iCalendar entry"
}]
}]
},
"differential" : {
"element" : [{
"id" : "Schedule",
"path" : "Schedule",
"short" : "A container for slots of time that may be available for booking appointments",
"definition" : "A container for slots of time that may be available for booking appointments.",
"alias" : ["Availability"],
"min" : 0,
"max" : "*",
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "ical",
"map" : "BEGIN:VFREEBUSY ??? END:VFREEBUSY (If your fhir server provides this information via calDAV, then you may want to include addressing information in a URL section, and with the search, a DTSTART and DTEND component can be included to indicate the range of time that has been covered in the collection of slots, where these overlap the resources period values. For all slots that reference this resource, include a FREEBUSY row for each slot)"
}]
},
{
"id" : "Schedule.identifier",
"path" : "Schedule.identifier",
"short" : "External Ids for this item",
"definition" : "External Ids for this item.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Identifier"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "ical",
"map" : "UID"
}]
},
{
"id" : "Schedule.active",
"path" : "Schedule.active",
"short" : "Whether this schedule is in active use",
"definition" : "Whether this schedule record is in active use or should not be used (such as was entered in error).",
"comment" : "This element is labeled as a modifier because it may be used to mark that the resource was created in error.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "boolean"
}],
"meaningWhenMissing" : "This resource is generally assumed to be active if no value is provided for the active element",
"isModifier" : true,
"isModifierReason" : "This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid",
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.status"
}]
},
{
"id" : "Schedule.serviceCategory",
"path" : "Schedule.serviceCategory",
"short" : "High-level category",
"definition" : "A broad categorization of the service that is to be performed during this appointment.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "service-category"
}],
"strength" : "example",
"valueSet" : "http://hl7.org/fhir/ValueSet/service-category"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.class"
}]
},
{
"id" : "Schedule.serviceType",
"path" : "Schedule.serviceType",
"short" : "Specific service",
"definition" : "The specific service that is to be performed during this appointment.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "service-type"
}],
"strength" : "example",
"valueSet" : "http://hl7.org/fhir/ValueSet/service-type"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.class"
},
{
"identity" : "ical",
"map" : "n/a"
}]
},
{
"id" : "Schedule.specialty",
"path" : "Schedule.specialty",
"short" : "Type of specialty needed",
"definition" : "The specialty of a practitioner that would be required to perform the service requested in this appointment.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "specialty"
}],
"strength" : "preferred",
"description" : "Additional details about where the content was created (e.g. clinical specialty).",
"valueSet" : "http://hl7.org/fhir/ValueSet/c80-practice-codes"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.class"
}]
},
{
"id" : "Schedule.actor",
"path" : "Schedule.actor",
"short" : "Resource(s) that availability information is being provided for",
"definition" : "Slots that reference this schedule resource provide the availability details to these referenced resource(s).",
"comment" : "The capacity to support multiple referenced resource types should be used in cases where the specific resources themselves cannot be scheduled without the other, and thus only make sense to the system exposing them as a group. Common examples of this are where the combination of a practitioner and a room (Location) are always required by a system.",
"min" : 1,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson",
"http://hl7.org/fhir/StructureDefinition/Device",
"http://hl7.org/fhir/StructureDefinition/HealthcareService",
"http://hl7.org/fhir/StructureDefinition/Location"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.subject[x]"
},
{
"identity" : "ical",
"map" : "ATTENDEE:MAILTO:john_public@host2.com This can be populated with a value from the referenced resource"
},
{
"identity" : "w5",
"map" : "FiveWs.subject"
}]
},
{
"id" : "Schedule.planningHorizon",
"path" : "Schedule.planningHorizon",
"short" : "Period of time covered by schedule",
"definition" : "The period of time that the slots that reference this Schedule resource cover (even if none exist). These cover the amount of time that an organization's planning horizon; the interval for which they are currently accepting appointments. This does not define a \"template\" for planning outside these dates.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Period"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.planned"
},
{
"identity" : "ical",
"map" : "DTSTART:20131201T003000Z DTEND:2014030101T003000Z"
}]
},
{
"id" : "Schedule.comment",
"path" : "Schedule.comment",
"short" : "Comments on availability",
"definition" : "Comments on the availability to describe any extended information. Such as custom constraints on the slots that may be associated.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"mapping" : [{
"identity" : "ical",
"map" : "COMMENT:(comment) If there is no comment, then the line can be excluded from the iCalendar entry"
}]
}]
}
}
},
{
"fullUrl" : "http://hl7.org/fhir/StructureDefinition/SearchParameter",
"resource" : {
"resourceType" : "StructureDefinition",
"id" : "SearchParameter",
"meta" : {
"lastUpdated" : "2019-11-01T09:29:23.356+11:00"
},
"text" : {
"status" : "generated",
"div" : "Name Flags Card. Type Description & Constraints SearchParameter ITU 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 xpath is present, there SHALL be an xpathUsage
+ Rule: Search parameters can only have chain names when the search parameter type is 'reference'
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension url Σ 1..1 uri Canonical identifier for this search parameter, represented as a URI (globally unique) version Σ 0..1 string Business version of the search parameter name ΣI 1..1 string Name for this search parameter (computer friendly) derivedFrom 0..1 canonical(SearchParameter) Original definition for the search parameter status ?!Σ 1..1 code draft | active | retired | unknown
PublicationStatus (Required) experimental Σ 0..1 boolean For testing purposes, not real usage date Σ 0..1 dateTime Date last changed publisher Σ 0..1 string Name of the publisher (organization or individual) contact Σ 0..* ContactDetail Contact details for the publisher
description Σ 1..1 markdown Natural language description of the search parameter useContext Σ 0..* UsageContext The context that the content is intended to support
jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for search parameter (if applicable)
Jurisdiction (Extensible)
purpose 0..1 markdown Why this search parameter is defined code Σ 1..1 code Code used in URL base Σ 1..* code The resource type(s) this search parameter applies to
ResourceType (Required)
type Σ 1..1 code number | date | string | token | reference | composite | quantity | uri | special
SearchParamType (Required) expression I 0..1 string FHIRPath expression that extracts the values xpath I 0..1 string XPath that extracts the values xpathUsage I 0..1 code normal | phonetic | nearby | distance | other
XPathUsageType (Required) target 0..* code Types of resource (if a resource reference)
ResourceType (Required)
multipleOr 0..1 boolean Allow multiple values per parameter (or) multipleAnd 0..1 boolean Allow multiple parameters (and) comparator 0..* code eq | ne | gt | lt | ge | le | sa | eb | ap
SearchComparator (Required)
modifier 0..* code missing | exact | contains | not | text | in | not-in | below | above | type | identifier | ofType
SearchModifierCode (Required)
chain 0..* string Chained names supported
component 0..* BackboneElement For Composite resources to define the parts
definition 1..1 canonical(SearchParameter) Defines how the part works expression 1..1 string Subexpression relative to main expression
Documentation for this format
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Foundation.Conformance"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 3
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "anonymous"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "fhir"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/SearchParameter",
"version" : "4.0.1",
"name" : "SearchParameter",
"status" : "draft",
"date" : "2019-11-01T09:29:23+11:00",
"publisher" : "Health Level Seven International (FHIR Infrastructure)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/fiwg/index.cfm"
}]
}],
"description" : "A search parameter that defines a named search item that can be used to search/filter on a resource.",
"fhirVersion" : "4.0.1",
"mapping" : [{
"identity" : "v2",
"uri" : "http://hl7.org/v2",
"name" : "HL7 v2 Mapping"
},
{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
},
{
"identity" : "workflow",
"uri" : "http://hl7.org/fhir/workflow",
"name" : "Workflow Pattern"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/fivews",
"name" : "FiveWs Pattern Mapping"
},
{
"identity" : "objimpl",
"uri" : "http://hl7.org/fhir/object-implementation",
"name" : "Object Implementation Information"
}],
"kind" : "resource",
"abstract" : false,
"type" : "SearchParameter",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"_baseDefinition" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-codegen-super",
"valueString" : "MetadataResource"
}]
},
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "SearchParameter",
"path" : "SearchParameter",
"short" : "Search parameter for a resource",
"definition" : "A search parameter that defines a named search item that can be used to search/filter on a resource.",
"comment" : "In FHIR, search is not performed directly on a resource (by XML or JSON path), but on a named parameter that maps into the resource content.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SearchParameter",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "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",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.`div`.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "spd-0",
"severity" : "warning",
"human" : "Name should be usable as an identifier for the module by machine processing applications such as code generation",
"expression" : "name.matches('[A-Z]([A-Za-z0-9_]){0,254}')",
"xpath" : "not(exists(f:name/@value)) or matches(f:name/@value, '[A-Z]([A-Za-z0-9_]){0,254}')"
},
{
"key" : "spd-1",
"severity" : "error",
"human" : "If an xpath is present, there SHALL be an xpathUsage",
"expression" : "xpath.empty() or xpathUsage.exists()",
"xpath" : "not(exists(f:xpath)) or exists(f:xpathUsage)"
},
{
"key" : "spd-2",
"severity" : "error",
"human" : "Search parameters can only have chain names when the search parameter type is 'reference'",
"expression" : "chain.empty() or type = 'reference'",
"xpath" : "not(exists(f:chain)) or (f:type/@value = 'reference')"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "v2",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "SearchParameter.id",
"path" : "SearchParameter.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SearchParameter.meta",
"path" : "SearchParameter.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SearchParameter.implicitRules",
"path" : "SearchParameter.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "SearchParameter.language",
"path" : "SearchParameter.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "SearchParameter.text",
"path" : "SearchParameter.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "SearchParameter.contained",
"path" : "SearchParameter.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "SearchParameter.extension",
"path" : "SearchParameter.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "SearchParameter.modifierExtension",
"path" : "SearchParameter.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "SearchParameter.url",
"path" : "SearchParameter.url",
"short" : "Canonical identifier for this search parameter, represented as a URI (globally unique)",
"definition" : "An absolute URI that is used to identify this search parameter when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this search parameter is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the search parameter is stored on different servers.",
"comment" : "Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.\n\nThe determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions). \n\nIn some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.",
"requirements" : "Allows the search parameter to be referenced by a single globally unique identifier. To allow referencing and reusing search parameter definitions under other names on operational systems (in case of name clash).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "SearchParameter.url",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.url"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
}]
},
{
"id" : "SearchParameter.version",
"path" : "SearchParameter.version",
"short" : "Business version of the search parameter",
"definition" : "The identifier that is used to identify this version of the search parameter when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the search parameter author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.",
"comment" : "There may be different search parameter instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the search parameter with the format [url]|[version].",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SearchParameter.version",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.version"
},
{
"identity" : "w5",
"map" : "FiveWs.version"
}]
},
{
"id" : "SearchParameter.name",
"path" : "SearchParameter.name",
"short" : "Name for this search parameter (computer friendly)",
"definition" : "A natural language name identifying the search parameter. This name should be usable as an identifier for the module by machine processing applications such as code generation.",
"comment" : "The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.",
"requirements" : "Support human navigation and code generation.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "SearchParameter.name",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"condition" : ["inv-0"],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SearchParameter.derivedFrom",
"path" : "SearchParameter.derivedFrom",
"short" : "Original definition for the search parameter",
"definition" : "Where this search parameter is originally defined. If a derivedFrom is provided, then the details in the search parameter must be consistent with the definition from which it is defined. i.e. the parameter should have the same meaning, and (usually) the functionality should be a proper subset of the underlying search parameter.",
"comment" : "The intent of this is that a server can designate that it provides support for a search parameter defined in the specification itself (e.g. [`value-quantity`](http://hl7.org/fhir/SearchParameter/Observation-value-quantity), but detail how it is supported by the server.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SearchParameter.derivedFrom",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/SearchParameter"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "SearchParameter.status",
"path" : "SearchParameter.status",
"short" : "draft | active | retired | unknown",
"definition" : "The status of this search parameter. Enables tracking the life-cycle of the content.",
"comment" : "Allows filtering of search parameters that are appropriate for use versus not.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "SearchParameter.status",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This is labeled as \"Is Modifier\" because applications should not use a retired {{title}} without due consideration",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "PublicationStatus"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "The lifecycle status of an artifact.",
"valueSet" : "http://hl7.org/fhir/ValueSet/publication-status|4.0.1"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.status"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
}]
},
{
"id" : "SearchParameter.experimental",
"path" : "SearchParameter.experimental",
"short" : "For testing purposes, not real usage",
"definition" : "A Boolean value to indicate that this search parameter is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.",
"comment" : "Allows filtering of search parameters that are appropriate for use versus not.",
"requirements" : "Enables experimental content to be developed following the same lifecycle that would be used for a production-level search parameter.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SearchParameter.experimental",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.experimental"
},
{
"identity" : "w5",
"map" : "FiveWs.class"
}]
},
{
"id" : "SearchParameter.date",
"path" : "SearchParameter.date",
"short" : "Date last changed",
"definition" : "The date (and optionally time) when the search parameter was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the search parameter changes.",
"comment" : "Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the search parameter. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.",
"alias" : ["Revision Date"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "SearchParameter.date",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.date"
},
{
"identity" : "w5",
"map" : "FiveWs.recorded"
}]
},
{
"id" : "SearchParameter.publisher",
"path" : "SearchParameter.publisher",
"short" : "Name of the publisher (organization or individual)",
"definition" : "The name of the organization or individual that published the search parameter.",
"comment" : "Usually an organization but may be an individual. The publisher (or steward) of the search parameter is the organization or individual primarily responsible for the maintenance and upkeep of the search parameter. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the search parameter. This item SHOULD be populated unless the information is available from context.",
"requirements" : "Helps establish the \"authority/credibility\" of the search parameter. May also allow for contact.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SearchParameter.publisher",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.publisher"
},
{
"identity" : "w5",
"map" : "FiveWs.witness"
}]
},
{
"id" : "SearchParameter.contact",
"path" : "SearchParameter.contact",
"short" : "Contact details for the publisher",
"definition" : "Contact details to assist a user in finding and communicating with the publisher.",
"comment" : "May be a web site, an email address, a telephone number, etc.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SearchParameter.contact",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "ContactDetail"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.contact"
}]
},
{
"id" : "SearchParameter.description",
"path" : "SearchParameter.description",
"short" : "Natural language description of the search parameter",
"definition" : "And how it used.",
"comment" : "This description can be used to capture details such as why the search parameter was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the search parameter as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the search parameter is presumed to be the predominant language in the place the search parameter was created).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "SearchParameter.description",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "markdown"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.description"
}]
},
{
"id" : "SearchParameter.useContext",
"path" : "SearchParameter.useContext",
"short" : "The context that the content is intended to support",
"definition" : "The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate search parameter instances.",
"comment" : "When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.",
"requirements" : "Assist in searching for appropriate content.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SearchParameter.useContext",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "UsageContext"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.useContext"
}]
},
{
"id" : "SearchParameter.jurisdiction",
"path" : "SearchParameter.jurisdiction",
"short" : "Intended jurisdiction for search parameter (if applicable)",
"definition" : "A legal or geographic region in which the search parameter is intended to be used.",
"comment" : "It may be possible for the search parameter to be used in jurisdictions other than those for which it was originally designed or intended.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SearchParameter.jurisdiction",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Jurisdiction"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "extensible",
"description" : "Countries and regions within which this artifact is targeted for use.",
"valueSet" : "http://hl7.org/fhir/ValueSet/jurisdiction"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.jurisdiction"
}]
},
{
"id" : "SearchParameter.purpose",
"path" : "SearchParameter.purpose",
"short" : "Why this search parameter is defined",
"definition" : "Explanation of why this search parameter is needed and why it has been designed as it has.",
"comment" : "This element does not describe the usage of the search parameter. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this search parameter.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SearchParameter.purpose",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "markdown"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.purpose"
},
{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "SearchParameter.code",
"path" : "SearchParameter.code",
"short" : "Code used in URL",
"definition" : "The code used in the URL or the parameter name in a parameters resource for this search parameter.",
"comment" : "For maximum compatibility, use only lowercase ASCII characters.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "SearchParameter.code",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SearchParameter.base",
"path" : "SearchParameter.base",
"short" : "The resource type(s) this search parameter applies to",
"definition" : "The base resource type(s) that this search parameter can be used against.",
"comment" : "A search parameter must always apply to at least one resource type. When search parameters apply to more than one resource type, they can be used against any of the listed resource types, or in a cross-type search (see [Cross Resource Search](http.html#xres-search)).",
"min" : 1,
"max" : "*",
"base" : {
"path" : "SearchParameter.base",
"min" : 1,
"max" : "*"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ResourceType"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "One of the resource types defined as part of this version of FHIR.",
"valueSet" : "http://hl7.org/fhir/ValueSet/resource-types|4.0.1"
}
},
{
"id" : "SearchParameter.type",
"path" : "SearchParameter.type",
"short" : "number | date | string | token | reference | composite | quantity | uri | special",
"definition" : "The type of value that a search parameter may contain, and how the content is interpreted.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "SearchParameter.type",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SearchParamType"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "Data types allowed to be used for search parameters.",
"valueSet" : "http://hl7.org/fhir/ValueSet/search-param-type|4.0.1"
}
},
{
"id" : "SearchParameter.expression",
"path" : "SearchParameter.expression",
"short" : "FHIRPath expression that extracts the values",
"definition" : "A FHIRPath expression that returns a set of elements for the search parameter.",
"comment" : "Note that the elements returned by the expression are sometimes complex elements where logic is required to determine quite how to handle them; e.g. CodeableConcepts may contain text and/or multiple codings, where the codings themselves contain a code and a system. For composite search parameters, the outcome of the expression must a collection of base elements from which the composites are derived.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SearchParameter.expression",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"condition" : ["spd-1"],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "SearchParameter.xpath",
"path" : "SearchParameter.xpath",
"short" : "XPath that extracts the values",
"definition" : "An XPath expression that returns a set of elements for the search parameter.",
"comment" : "Note that the elements returned by the XPath are sometimes complex elements where logic is required to determine quite how to handle them; e.g. CodeableConcepts may contain text and/or multiple codings, where the codings themselves contain a code and a system.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SearchParameter.xpath",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"condition" : ["spd-1"],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "SearchParameter.xpathUsage",
"path" : "SearchParameter.xpathUsage",
"short" : "normal | phonetic | nearby | distance | other",
"definition" : "How the search parameter relates to the set of elements returned by evaluating the xpath query.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SearchParameter.xpathUsage",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"condition" : ["spd-1"],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "XPathUsageType"
}],
"strength" : "required",
"description" : "How a search parameter relates to the set of elements returned by evaluating its xpath query.",
"valueSet" : "http://hl7.org/fhir/ValueSet/search-xpath-usage|4.0.1"
}
},
{
"id" : "SearchParameter.target",
"path" : "SearchParameter.target",
"short" : "Types of resource (if a resource reference)",
"definition" : "Types of resource (if a resource is referenced).",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SearchParameter.target",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ResourceType"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "One of the resource types defined as part of this version of FHIR.",
"valueSet" : "http://hl7.org/fhir/ValueSet/resource-types|4.0.1"
}
},
{
"id" : "SearchParameter.multipleOr",
"path" : "SearchParameter.multipleOr",
"short" : "Allow multiple values per parameter (or)",
"definition" : "Whether multiple values are allowed for each time the parameter exists. Values are separated by commas, and the parameter matches if any of the values match.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SearchParameter.multipleOr",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "SearchParameter.multipleAnd",
"path" : "SearchParameter.multipleAnd",
"short" : "Allow multiple parameters (and)",
"definition" : "Whether multiple parameters are allowed - e.g. more than one parameter with the same name. The search matches if all the parameters match.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SearchParameter.multipleAnd",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "SearchParameter.comparator",
"path" : "SearchParameter.comparator",
"short" : "eq | ne | gt | lt | ge | le | sa | eb | ap",
"definition" : "Comparators supported for the search parameter.",
"comment" : "If no comparators are listed, clients should not expect servers to support any comparators.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SearchParameter.comparator",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SearchComparator"
}],
"strength" : "required",
"description" : "What Search Comparator Codes are supported in search.",
"valueSet" : "http://hl7.org/fhir/ValueSet/search-comparator|4.0.1"
}
},
{
"id" : "SearchParameter.modifier",
"path" : "SearchParameter.modifier",
"short" : "missing | exact | contains | not | text | in | not-in | below | above | type | identifier | ofType",
"definition" : "A modifier supported for the search parameter.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SearchParameter.modifier",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SearchModifierCode"
}],
"strength" : "required",
"description" : "A supported modifier for a search parameter.",
"valueSet" : "http://hl7.org/fhir/ValueSet/search-modifier-code|4.0.1"
}
},
{
"id" : "SearchParameter.chain",
"path" : "SearchParameter.chain",
"short" : "Chained names supported",
"definition" : "Contains the names of any search parameters which may be chained to the containing search parameter. Chained parameters may be added to search parameters of type reference and specify that resources will only be returned if they contain a reference to a resource which matches the chained parameter value. Values for this field should be drawn from SearchParameter.code for a parameter on the target resource type.",
"comment" : "Systems are not required to list all the chain names they support, but if they don't list them, clients might not know to use them.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SearchParameter.chain",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "SearchParameter.component",
"path" : "SearchParameter.component",
"short" : "For Composite resources to define the parts",
"definition" : "Used to define the parts of a composite search parameter.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SearchParameter.component",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "SearchParameter.component.id",
"path" : "SearchParameter.component.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "SearchParameter.component.extension",
"path" : "SearchParameter.component.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "SearchParameter.component.modifierExtension",
"path" : "SearchParameter.component.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "SearchParameter.component.definition",
"path" : "SearchParameter.component.definition",
"short" : "Defines how the part works",
"definition" : "The definition of the search parameter that describes this part.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "SearchParameter.component.definition",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/SearchParameter"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "SearchParameter.component.expression",
"path" : "SearchParameter.component.expression",
"short" : "Subexpression relative to main expression",
"definition" : "A sub-expression that defines how to extract values for this component from the output of the main SearchParameter.expression.",
"comment" : "This expression overrides the expression in the definition and extracts the index values from the outcome of the composite expression.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "SearchParameter.component.expression",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
}]
},
"differential" : {
"element" : [{
"id" : "SearchParameter",
"path" : "SearchParameter",
"short" : "Search parameter for a resource",
"definition" : "A search parameter that defines a named search item that can be used to search/filter on a resource.",
"comment" : "In FHIR, search is not performed directly on a resource (by XML or JSON path), but on a named parameter that maps into the resource content.",
"min" : 0,
"max" : "*",
"constraint" : [{
"key" : "spd-0",
"severity" : "warning",
"human" : "Name should be usable as an identifier for the module by machine processing applications such as code generation",
"expression" : "name.matches('[A-Z]([A-Za-z0-9_]){0,254}')",
"xpath" : "not(exists(f:name/@value)) or matches(f:name/@value, '[A-Z]([A-Za-z0-9_]){0,254}')"
},
{
"key" : "spd-1",
"severity" : "error",
"human" : "If an xpath is present, there SHALL be an xpathUsage",
"expression" : "xpath.empty() or xpathUsage.exists()",
"xpath" : "not(exists(f:xpath)) or exists(f:xpathUsage)"
},
{
"key" : "spd-2",
"severity" : "error",
"human" : "Search parameters can only have chain names when the search parameter type is 'reference'",
"expression" : "chain.empty() or type = 'reference'",
"xpath" : "not(exists(f:chain)) or (f:type/@value = 'reference')"
}],
"mapping" : [{
"identity" : "v2",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "SearchParameter.url",
"path" : "SearchParameter.url",
"short" : "Canonical identifier for this search parameter, represented as a URI (globally unique)",
"definition" : "An absolute URI that is used to identify this search parameter when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this search parameter is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the search parameter is stored on different servers.",
"comment" : "Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.\n\nThe determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions). \n\nIn some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.",
"requirements" : "Allows the search parameter to be referenced by a single globally unique identifier. To allow referencing and reusing search parameter definitions under other names on operational systems (in case of name clash).",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "uri"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.url"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
}]
},
{
"id" : "SearchParameter.version",
"path" : "SearchParameter.version",
"short" : "Business version of the search parameter",
"definition" : "The identifier that is used to identify this version of the search parameter when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the search parameter author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.",
"comment" : "There may be different search parameter instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the search parameter with the format [url]|[version].",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.version"
},
{
"identity" : "w5",
"map" : "FiveWs.version"
}]
},
{
"id" : "SearchParameter.name",
"path" : "SearchParameter.name",
"short" : "Name for this search parameter (computer friendly)",
"definition" : "A natural language name identifying the search parameter. This name should be usable as an identifier for the module by machine processing applications such as code generation.",
"comment" : "The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.",
"requirements" : "Support human navigation and code generation.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "string"
}],
"condition" : ["inv-0"],
"isSummary" : true
},
{
"id" : "SearchParameter.derivedFrom",
"path" : "SearchParameter.derivedFrom",
"short" : "Original definition for the search parameter",
"definition" : "Where this search parameter is originally defined. If a derivedFrom is provided, then the details in the search parameter must be consistent with the definition from which it is defined. i.e. the parameter should have the same meaning, and (usually) the functionality should be a proper subset of the underlying search parameter.",
"comment" : "The intent of this is that a server can designate that it provides support for a search parameter defined in the specification itself (e.g. [`value-quantity`](http://hl7.org/fhir/SearchParameter/Observation-value-quantity), but detail how it is supported by the server.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/SearchParameter"]
}]
},
{
"id" : "SearchParameter.status",
"path" : "SearchParameter.status",
"short" : "draft | active | retired | unknown",
"definition" : "The status of this search parameter. Enables tracking the life-cycle of the content.",
"comment" : "Allows filtering of search parameters that are appropriate for use versus not.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isModifier" : true,
"isModifierReason" : "This is labeled as \"Is Modifier\" because applications should not use a retired {{title}} without due consideration",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "PublicationStatus"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "The lifecycle status of an artifact.",
"valueSet" : "http://hl7.org/fhir/ValueSet/publication-status|4.0.1"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.status"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
}]
},
{
"id" : "SearchParameter.experimental",
"path" : "SearchParameter.experimental",
"short" : "For testing purposes, not real usage",
"definition" : "A Boolean value to indicate that this search parameter is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.",
"comment" : "Allows filtering of search parameters that are appropriate for use versus not.",
"requirements" : "Enables experimental content to be developed following the same lifecycle that would be used for a production-level search parameter.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "boolean"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.experimental"
},
{
"identity" : "w5",
"map" : "FiveWs.class"
}]
},
{
"id" : "SearchParameter.date",
"path" : "SearchParameter.date",
"short" : "Date last changed",
"definition" : "The date (and optionally time) when the search parameter was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the search parameter changes.",
"comment" : "Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the search parameter. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.",
"alias" : ["Revision Date"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "dateTime"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.date"
},
{
"identity" : "w5",
"map" : "FiveWs.recorded"
}]
},
{
"id" : "SearchParameter.publisher",
"path" : "SearchParameter.publisher",
"short" : "Name of the publisher (organization or individual)",
"definition" : "The name of the organization or individual that published the search parameter.",
"comment" : "Usually an organization but may be an individual. The publisher (or steward) of the search parameter is the organization or individual primarily responsible for the maintenance and upkeep of the search parameter. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the search parameter. This item SHOULD be populated unless the information is available from context.",
"requirements" : "Helps establish the \"authority/credibility\" of the search parameter. May also allow for contact.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.publisher"
},
{
"identity" : "w5",
"map" : "FiveWs.witness"
}]
},
{
"id" : "SearchParameter.contact",
"path" : "SearchParameter.contact",
"short" : "Contact details for the publisher",
"definition" : "Contact details to assist a user in finding and communicating with the publisher.",
"comment" : "May be a web site, an email address, a telephone number, etc.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "ContactDetail"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.contact"
}]
},
{
"id" : "SearchParameter.description",
"path" : "SearchParameter.description",
"short" : "Natural language description of the search parameter",
"definition" : "And how it used.",
"comment" : "This description can be used to capture details such as why the search parameter was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the search parameter as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the search parameter is presumed to be the predominant language in the place the search parameter was created).",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "markdown"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.description"
}]
},
{
"id" : "SearchParameter.useContext",
"path" : "SearchParameter.useContext",
"short" : "The context that the content is intended to support",
"definition" : "The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate search parameter instances.",
"comment" : "When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.",
"requirements" : "Assist in searching for appropriate content.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "UsageContext"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.useContext"
}]
},
{
"id" : "SearchParameter.jurisdiction",
"path" : "SearchParameter.jurisdiction",
"short" : "Intended jurisdiction for search parameter (if applicable)",
"definition" : "A legal or geographic region in which the search parameter is intended to be used.",
"comment" : "It may be possible for the search parameter to be used in jurisdictions other than those for which it was originally designed or intended.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Jurisdiction"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "extensible",
"description" : "Countries and regions within which this artifact is targeted for use.",
"valueSet" : "http://hl7.org/fhir/ValueSet/jurisdiction"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.jurisdiction"
}]
},
{
"id" : "SearchParameter.purpose",
"path" : "SearchParameter.purpose",
"short" : "Why this search parameter is defined",
"definition" : "Explanation of why this search parameter is needed and why it has been designed as it has.",
"comment" : "This element does not describe the usage of the search parameter. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this search parameter.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "markdown"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.purpose"
},
{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "SearchParameter.code",
"path" : "SearchParameter.code",
"short" : "Code used in URL",
"definition" : "The code used in the URL or the parameter name in a parameters resource for this search parameter.",
"comment" : "For maximum compatibility, use only lowercase ASCII characters.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isSummary" : true
},
{
"id" : "SearchParameter.base",
"path" : "SearchParameter.base",
"short" : "The resource type(s) this search parameter applies to",
"definition" : "The base resource type(s) that this search parameter can be used against.",
"comment" : "A search parameter must always apply to at least one resource type. When search parameters apply to more than one resource type, they can be used against any of the listed resource types, or in a cross-type search (see [Cross Resource Search](http.html#xres-search)).",
"min" : 1,
"max" : "*",
"type" : [{
"code" : "code"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ResourceType"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "One of the resource types defined as part of this version of FHIR.",
"valueSet" : "http://hl7.org/fhir/ValueSet/resource-types|4.0.1"
}
},
{
"id" : "SearchParameter.type",
"path" : "SearchParameter.type",
"short" : "number | date | string | token | reference | composite | quantity | uri | special",
"definition" : "The type of value that a search parameter may contain, and how the content is interpreted.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SearchParamType"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "Data types allowed to be used for search parameters.",
"valueSet" : "http://hl7.org/fhir/ValueSet/search-param-type|4.0.1"
}
},
{
"id" : "SearchParameter.expression",
"path" : "SearchParameter.expression",
"short" : "FHIRPath expression that extracts the values",
"definition" : "A FHIRPath expression that returns a set of elements for the search parameter.",
"comment" : "Note that the elements returned by the expression are sometimes complex elements where logic is required to determine quite how to handle them; e.g. CodeableConcepts may contain text and/or multiple codings, where the codings themselves contain a code and a system. For composite search parameters, the outcome of the expression must a collection of base elements from which the composites are derived.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"condition" : ["spd-1"]
},
{
"id" : "SearchParameter.xpath",
"path" : "SearchParameter.xpath",
"short" : "XPath that extracts the values",
"definition" : "An XPath expression that returns a set of elements for the search parameter.",
"comment" : "Note that the elements returned by the XPath are sometimes complex elements where logic is required to determine quite how to handle them; e.g. CodeableConcepts may contain text and/or multiple codings, where the codings themselves contain a code and a system.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"condition" : ["spd-1"]
},
{
"id" : "SearchParameter.xpathUsage",
"path" : "SearchParameter.xpathUsage",
"short" : "normal | phonetic | nearby | distance | other",
"definition" : "How the search parameter relates to the set of elements returned by evaluating the xpath query.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "code"
}],
"condition" : ["spd-1"],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "XPathUsageType"
}],
"strength" : "required",
"description" : "How a search parameter relates to the set of elements returned by evaluating its xpath query.",
"valueSet" : "http://hl7.org/fhir/ValueSet/search-xpath-usage|4.0.1"
}
},
{
"id" : "SearchParameter.target",
"path" : "SearchParameter.target",
"short" : "Types of resource (if a resource reference)",
"definition" : "Types of resource (if a resource is referenced).",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "code"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ResourceType"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "One of the resource types defined as part of this version of FHIR.",
"valueSet" : "http://hl7.org/fhir/ValueSet/resource-types|4.0.1"
}
},
{
"id" : "SearchParameter.multipleOr",
"path" : "SearchParameter.multipleOr",
"short" : "Allow multiple values per parameter (or)",
"definition" : "Whether multiple values are allowed for each time the parameter exists. Values are separated by commas, and the parameter matches if any of the values match.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "boolean"
}]
},
{
"id" : "SearchParameter.multipleAnd",
"path" : "SearchParameter.multipleAnd",
"short" : "Allow multiple parameters (and)",
"definition" : "Whether multiple parameters are allowed - e.g. more than one parameter with the same name. The search matches if all the parameters match.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "boolean"
}]
},
{
"id" : "SearchParameter.comparator",
"path" : "SearchParameter.comparator",
"short" : "eq | ne | gt | lt | ge | le | sa | eb | ap",
"definition" : "Comparators supported for the search parameter.",
"comment" : "If no comparators are listed, clients should not expect servers to support any comparators.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "code"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SearchComparator"
}],
"strength" : "required",
"description" : "What Search Comparator Codes are supported in search.",
"valueSet" : "http://hl7.org/fhir/ValueSet/search-comparator|4.0.1"
}
},
{
"id" : "SearchParameter.modifier",
"path" : "SearchParameter.modifier",
"short" : "missing | exact | contains | not | text | in | not-in | below | above | type | identifier | ofType",
"definition" : "A modifier supported for the search parameter.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "code"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SearchModifierCode"
}],
"strength" : "required",
"description" : "A supported modifier for a search parameter.",
"valueSet" : "http://hl7.org/fhir/ValueSet/search-modifier-code|4.0.1"
}
},
{
"id" : "SearchParameter.chain",
"path" : "SearchParameter.chain",
"short" : "Chained names supported",
"definition" : "Contains the names of any search parameters which may be chained to the containing search parameter. Chained parameters may be added to search parameters of type reference and specify that resources will only be returned if they contain a reference to a resource which matches the chained parameter value. Values for this field should be drawn from SearchParameter.code for a parameter on the target resource type.",
"comment" : "Systems are not required to list all the chain names they support, but if they don't list them, clients might not know to use them.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "string"
}]
},
{
"id" : "SearchParameter.component",
"path" : "SearchParameter.component",
"short" : "For Composite resources to define the parts",
"definition" : "Used to define the parts of a composite search parameter.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "SearchParameter.component.definition",
"path" : "SearchParameter.component.definition",
"short" : "Defines how the part works",
"definition" : "The definition of the search parameter that describes this part.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/SearchParameter"]
}]
},
{
"id" : "SearchParameter.component.expression",
"path" : "SearchParameter.component.expression",
"short" : "Subexpression relative to main expression",
"definition" : "A sub-expression that defines how to extract values for this component from the output of the main SearchParameter.expression.",
"comment" : "This expression overrides the expression in the definition and extracts the index values from the outcome of the composite expression.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "string"
}]
}]
}
}
},
{
"fullUrl" : "http://hl7.org/fhir/StructureDefinition/ServiceRequest",
"resource" : {
"resourceType" : "StructureDefinition",
"id" : "ServiceRequest",
"meta" : {
"lastUpdated" : "2019-11-01T09:29:23.356+11:00"
},
"text" : {
"status" : "generated",
"div" : "Name Flags Card. Type Description & Constraints ServiceRequest ITU DomainResource A request for a service to be performed
+ Rule: orderDetail SHALL only be present if code is present
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension identifier Σ 0..* Identifier Identifiers assigned to this order
instantiatesCanonical Σ 0..* canonical(ActivityDefinition | PlanDefinition) Instantiates FHIR protocol or definition
instantiatesUri Σ 0..* uri Instantiates external protocol or definition
basedOn Σ 0..* Reference(CarePlan | ServiceRequest | MedicationRequest) What request fulfills
replaces Σ 0..* Reference(ServiceRequest) What request replaces
requisition Σ 0..1 Identifier Composite Request ID status ?!Σ 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
RequestStatus (Required) intent ?!Σ 1..1 code proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
RequestIntent (Required) category Σ 0..* CodeableConcept Classification of service
Service Request Category Codes (Example)
priority Σ 0..1 code routine | urgent | asap | stat
Request priority (Required) doNotPerform ?!Σ 0..1 boolean True if service/procedure should not be performed code Σ 0..1 CodeableConcept What is being requested/ordered
Procedure Codes (SNOMED CT) (Example) orderDetail ΣI 0..* CodeableConcept Additional order information
Service Request Order Details Codes (Example)
quantity[x] Σ 0..1 Service amount quantityQuantity Quantity quantityRatio Ratio quantityRange Range subject Σ 1..1 Reference(Patient | Group | Location | Device) Individual or Entity the service is ordered for encounter Σ 0..1 Reference(Encounter) Encounter in which the request was created occurrence[x] Σ 0..1 When service should occur occurrenceDateTime dateTime occurrencePeriod Period occurrenceTiming Timing asNeeded[x] Σ 0..1 Preconditions for service
SNOMED CT Medication As Needed Reason Codes (Example) asNeededBoolean boolean asNeededCodeableConcept CodeableConcept authoredOn Σ 0..1 dateTime Date request signed requester Σ 0..1 Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) Who/what is requesting service performerType Σ 0..1 CodeableConcept Performer role
Participant Roles (Example) performer Σ 0..* Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) Requested performer
locationCode Σ 0..* CodeableConcept Requested location
V3 Value SetServiceDeliveryLocationRoleType (Example)
locationReference Σ 0..* Reference(Location) Requested location
reasonCode Σ 0..* CodeableConcept Explanation/Justification for procedure or service
Procedure Reason Codes (Example)
reasonReference Σ 0..* Reference(Condition | Observation | DiagnosticReport | DocumentReference) Explanation/Justification for service or service
insurance 0..* Reference(Coverage | ClaimResponse) Associated insurance coverage
supportingInfo 0..* Reference(Any) Additional clinical information
specimen Σ 0..* Reference(Specimen) Procedure Samples
bodySite Σ 0..* CodeableConcept Location on Body
SNOMED CT Body Structures (Example)
note 0..* Annotation Comments
patientInstruction Σ 0..1 string Patient or consumer-oriented instructions relevantHistory 0..* Reference(Provenance) Request provenance
Documentation for this format
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Clinical.Care Provision"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 2
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "patient"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "oo"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/ServiceRequest",
"version" : "4.0.1",
"name" : "ServiceRequest",
"status" : "draft",
"date" : "2019-11-01T09:29:23+11:00",
"publisher" : "Health Level Seven International (Orders and Observations)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/orders/index.cfm"
}]
}],
"description" : "A record of a request for service such as diagnostic investigations, treatments, or operations to be performed.",
"fhirVersion" : "4.0.1",
"mapping" : [{
"identity" : "workflow",
"uri" : "http://hl7.org/fhir/workflow",
"name" : "Workflow Pattern"
},
{
"identity" : "v2",
"uri" : "http://hl7.org/v2",
"name" : "HL7 v2 Mapping"
},
{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/fivews",
"name" : "FiveWs Pattern Mapping"
},
{
"identity" : "quick",
"uri" : "http://siframework.org/cqf",
"name" : "Quality Improvement and Clinical Knowledge (QUICK)"
}],
"kind" : "resource",
"abstract" : false,
"type" : "ServiceRequest",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "ServiceRequest",
"path" : "ServiceRequest",
"short" : "A request for a service to be performed",
"definition" : "A record of a request for service such as diagnostic investigations, treatments, or operations to be performed.",
"alias" : ["diagnostic request",
"referral",
"referral request",
"transfer of care request"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "ServiceRequest",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "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",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.`div`.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "prr-1",
"severity" : "error",
"human" : "orderDetail SHALL only be present if code is present",
"expression" : "orderDetail.empty() or code.exists()",
"xpath" : "exists(f:code) or not(exists(f:orderDetail))"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "workflow",
"map" : "Request"
},
{
"identity" : "v2",
"map" : "ORC"
},
{
"identity" : "rim",
"map" : "Act[moodCode<=INT]"
}]
},
{
"id" : "ServiceRequest.id",
"path" : "ServiceRequest.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "ServiceRequest.meta",
"path" : "ServiceRequest.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "ServiceRequest.implicitRules",
"path" : "ServiceRequest.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "ServiceRequest.language",
"path" : "ServiceRequest.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "ServiceRequest.text",
"path" : "ServiceRequest.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "ServiceRequest.contained",
"path" : "ServiceRequest.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ServiceRequest.extension",
"path" : "ServiceRequest.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ServiceRequest.modifierExtension",
"path" : "ServiceRequest.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ServiceRequest.identifier",
"path" : "ServiceRequest.identifier",
"short" : "Identifiers assigned to this order",
"definition" : "Identifiers assigned to this order instance by the orderer and/or the receiver and/or order fulfiller.",
"comment" : "The identifier.type element is used to distinguish between the identifiers assigned by the orderer (known as the 'Placer' in HL7 v2) and the producer of the observations in response to the order (known as the 'Filler' in HL7 v2). For further discussion and examples see the resource notes section below.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ServiceRequest.identifier",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Identifier"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.identifier"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "v2",
"map" : "ORC.2, ORC.3, RF1-6 / RF1-11,"
},
{
"identity" : "rim",
"map" : ".identifier"
},
{
"identity" : "quick",
"map" : "ClinicalStatement.identifier"
}]
},
{
"id" : "ServiceRequest.instantiatesCanonical",
"path" : "ServiceRequest.instantiatesCanonical",
"short" : "Instantiates FHIR protocol or definition",
"definition" : "The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this ServiceRequest.",
"comment" : "Note: This is a business identifier, not a resource identifier (see [discussion](resource.html#identifiers)). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ServiceRequest.instantiatesCanonical",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ActivityDefinition",
"http://hl7.org/fhir/StructureDefinition/PlanDefinition"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.instantiatesCanonical"
},
{
"identity" : "v2",
"map" : "Varies by domain"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=DEFN].target"
}]
},
{
"id" : "ServiceRequest.instantiatesUri",
"path" : "ServiceRequest.instantiatesUri",
"short" : "Instantiates external protocol or definition",
"definition" : "The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this ServiceRequest.",
"comment" : "This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ServiceRequest.instantiatesUri",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.instantiatesUri"
},
{
"identity" : "v2",
"map" : "Varies by domain"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=DEFN].target"
}]
},
{
"id" : "ServiceRequest.basedOn",
"path" : "ServiceRequest.basedOn",
"short" : "What request fulfills",
"definition" : "Plan/proposal/order fulfilled by this request.",
"alias" : ["fulfills"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "ServiceRequest.basedOn",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/CarePlan",
"http://hl7.org/fhir/StructureDefinition/ServiceRequest",
"http://hl7.org/fhir/StructureDefinition/MedicationRequest"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.basedOn"
},
{
"identity" : "v2",
"map" : "ORC.8 (plus others)"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=FLFS].target"
}]
},
{
"id" : "ServiceRequest.replaces",
"path" : "ServiceRequest.replaces",
"short" : "What request replaces",
"definition" : "The request takes the place of the referenced completed or terminated request(s).",
"alias" : ["supersedes",
"prior",
"renewed order"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "ServiceRequest.replaces",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ServiceRequest"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.replaces"
},
{
"identity" : "v2",
"map" : "Handled by message location of ORC (ORC.1=RO or RU)"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=RPLC].target"
}]
},
{
"id" : "ServiceRequest.requisition",
"path" : "ServiceRequest.requisition",
"short" : "Composite Request ID",
"definition" : "A shared identifier common to all service requests that were authorized more or less simultaneously by a single author, representing the composite or group identifier.",
"comment" : "Requests are linked either by a \"basedOn\" relationship (i.e. one request is fulfilling another) or by having a common requisition. Requests that are part of the same requisition are generally treated independently from the perspective of changing their state or maintaining them after initial creation.",
"requirements" : "Some business processes need to know if multiple items were ordered as part of the same \"requisition\" for billing or other purposes.",
"alias" : ["grouperId",
"groupIdentifier"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "ServiceRequest.requisition",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Identifier"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.groupIdentifier"
},
{
"identity" : "v2",
"map" : "ORC.4"
},
{
"identity" : "rim",
"map" : ".inboundRelationship(typeCode=COMP].source[moodCode=INT].identifier"
}]
},
{
"id" : "ServiceRequest.status",
"path" : "ServiceRequest.status",
"short" : "draft | active | on-hold | revoked | completed | entered-in-error | unknown",
"definition" : "The status of the order.",
"comment" : "The status is generally fully in the control of the requester - they determine whether the order is draft or active and, after it has been activated, competed, cancelled or suspended. States relating to the activities of the performer are reflected on either the corresponding event (see [Event Pattern](event.html) for general discussion) or using the [Task](task.html) resource.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ServiceRequest.status",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ServiceRequestStatus"
}],
"strength" : "required",
"description" : "The status of a service order.",
"valueSet" : "http://hl7.org/fhir/ValueSet/request-status|4.0.1"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.status"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
},
{
"identity" : "v2",
"map" : "ORC.5,RF1-1"
},
{
"identity" : "rim",
"map" : ".status"
},
{
"identity" : "quick",
"map" : "Action.currentStatus"
}]
},
{
"id" : "ServiceRequest.intent",
"path" : "ServiceRequest.intent",
"short" : "proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option",
"definition" : "Whether the request is a proposal, plan, an original order or a reflex order.",
"comment" : "This element is labeled as a modifier because the intent alters when and how the resource is actually applicable.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ServiceRequest.intent",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element changes the interpretation of all descriptive attributes. For example \"the time the request is recommended to occur\" vs. \"the time the request is authorized to occur\" or \"who is recommended to perform the request\" vs. \"who is authorized to perform the request",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ServiceRequestIntent"
}],
"strength" : "required",
"description" : "The kind of service request.",
"valueSet" : "http://hl7.org/fhir/ValueSet/request-intent|4.0.1"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.intent"
},
{
"identity" : "w5",
"map" : "FiveWs.class"
},
{
"identity" : "v2",
"map" : "N/A"
},
{
"identity" : "rim",
"map" : ".moodCode (nuances beyond PRP/PLAN/RQO would need to be elsewhere)"
}]
},
{
"id" : "ServiceRequest.category",
"path" : "ServiceRequest.category",
"short" : "Classification of service",
"definition" : "A code that classifies the service for searching, sorting and display purposes (e.g. \"Surgical Procedure\").",
"comment" : "There may be multiple axis of categorization depending on the context or use case for retrieving or displaying the resource. The level of granularity is defined by the category concepts in the value set.",
"requirements" : "Used for filtering what service request are retrieved and displayed.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ServiceRequest.category",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ServiceRequestCategory"
}],
"strength" : "example",
"description" : "Classification of the requested service.",
"valueSet" : "http://hl7.org/fhir/ValueSet/servicerequest-category"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.class"
},
{
"identity" : "v2",
"map" : "RF1-5"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=\"COMP].target[classCode=\"LIST\", moodCode=\"INT\"].code"
}]
},
{
"id" : "ServiceRequest.priority",
"path" : "ServiceRequest.priority",
"short" : "routine | urgent | asap | stat",
"definition" : "Indicates how quickly the ServiceRequest should be addressed with respect to other requests.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ServiceRequest.priority",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"meaningWhenMissing" : "If missing, this task should be performed with normal priority",
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ServiceRequestPriority"
}],
"strength" : "required",
"description" : "Identifies the level of importance to be assigned to actioning the request.",
"valueSet" : "http://hl7.org/fhir/ValueSet/request-priority|4.0.1"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.priority"
},
{
"identity" : "w5",
"map" : "FiveWs.grade"
},
{
"identity" : "v2",
"map" : "TQ1.9, RF1-2"
},
{
"identity" : "rim",
"map" : ".priorityCode"
}]
},
{
"id" : "ServiceRequest.doNotPerform",
"path" : "ServiceRequest.doNotPerform",
"short" : "True if service/procedure should not be performed",
"definition" : "Set this to true if the record is saying that the service/procedure should NOT be performed.",
"comment" : "In general, only the code and timeframe will be present, though occasional additional qualifiers such as body site or even performer could be included to narrow the scope of the prohibition. If the ServiceRequest.code and ServiceRequest.doNotPerform both contain negation, that will reinforce prohibition and should not have a double negative interpretation.",
"requirements" : "Used for do not ambulate, do not elevate head of bed, do not flush NG tube, do not take blood pressure on a certain arm, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ServiceRequest.doNotPerform",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"meaningWhenMissing" : "If missing, the request is a positive request e.g. \"do perform\"",
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "If true this element negates the specified action. For Example, instead of a request for a procedure, it is a request for the procedure to not occur.",
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.doNotPerform"
},
{
"identity" : "rim",
"map" : ".actionNegationInd"
}]
},
{
"id" : "ServiceRequest.code",
"path" : "ServiceRequest.code",
"short" : "What is being requested/ordered",
"definition" : "A code that identifies a particular service (i.e., procedure, diagnostic investigation, or panel of investigations) that have been requested.",
"comment" : "Many laboratory and radiology procedure codes embed the specimen/organ system in the test order name, for example, serum or serum/plasma glucose, or a chest x-ray. The specimen might not be recorded separately from the test code.",
"alias" : ["service requested"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "ServiceRequest.code",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ServiceRequestCode"
}],
"strength" : "example",
"description" : "Codes for tests or services that can be carried out by a designated individual, organization or healthcare service. For laboratory, LOINC is (preferred)[http://build.fhir.org/terminologies.html#preferred] and a valueset using LOINC Order codes is available [here](valueset-diagnostic-requests.html).",
"valueSet" : "http://hl7.org/fhir/ValueSet/procedure-code"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.code"
},
{
"identity" : "w5",
"map" : "FiveWs.what[x]"
},
{
"identity" : "v2",
"map" : "PR1-3 / OBR-4 (varies by domain)"
},
{
"identity" : "rim",
"map" : ".code"
},
{
"identity" : "quick",
"map" : "Procedure.procedureCode"
}]
},
{
"id" : "ServiceRequest.orderDetail",
"path" : "ServiceRequest.orderDetail",
"short" : "Additional order information",
"definition" : "Additional details and instructions about the how the services are to be delivered. For example, and order for a urinary catheter may have an order detail for an external or indwelling catheter, or an order for a bandage may require additional instructions specifying how the bandage should be applied.",
"comment" : "For information from the medical record intended to support the delivery of the requested services, use the `supportingInformation` element.",
"alias" : ["detailed instructions"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "ServiceRequest.orderDetail",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"condition" : ["prr-1"],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "OrderDetail"
}],
"strength" : "example",
"description" : "Codified order entry details which are based on order context.",
"valueSet" : "http://hl7.org/fhir/ValueSet/servicerequest-orderdetail"
},
"mapping" : [{
"identity" : "v2",
"map" : "NTE"
},
{
"identity" : "rim",
"map" : ".code"
},
{
"identity" : "quick",
"map" : "Procedure.procedureCode"
}]
},
{
"id" : "ServiceRequest.quantity[x]",
"path" : "ServiceRequest.quantity[x]",
"short" : "Service amount",
"definition" : "An amount of service being requested which can be a quantity ( for example $1,500 home modification), a ratio ( for example, 20 half day visits per month), or a range (2.0 to 1.8 Gy per fraction).",
"requirements" : "When ordering a service the number of service items may need to be specified separately from the the service item.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ServiceRequest.quantity[x]",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Quantity"
},
{
"code" : "Ratio"
},
{
"code" : "Range"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "v2",
"map" : "NTE"
},
{
"identity" : "rim",
"map" : ".quantity"
}]
},
{
"id" : "ServiceRequest.subject",
"path" : "ServiceRequest.subject",
"short" : "Individual or Entity the service is ordered for",
"definition" : "On whom or what the service is to be performed. This is usually a human patient, but can also be requested on animals, groups of humans or animals, devices such as dialysis machines, or even locations (typically for environmental scans).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ServiceRequest.subject",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Group",
"http://hl7.org/fhir/StructureDefinition/Location",
"http://hl7.org/fhir/StructureDefinition/Device"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.subject"
},
{
"identity" : "w5",
"map" : "FiveWs.subject[x]"
},
{
"identity" : "v2",
"map" : "PID"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=SBJ].role"
},
{
"identity" : "quick",
"map" : "ClinicalStatement.subject"
},
{
"identity" : "w5",
"map" : "FiveWs.subject"
}]
},
{
"id" : "ServiceRequest.encounter",
"path" : "ServiceRequest.encounter",
"short" : "Encounter in which the request was created",
"definition" : "An encounter that provides additional information about the healthcare context in which this request is made.",
"alias" : ["context"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "ServiceRequest.encounter",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Encounter"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.encounter"
},
{
"identity" : "w5",
"map" : "FiveWs.context"
},
{
"identity" : "v2",
"map" : "PV1"
},
{
"identity" : "rim",
"map" : ".inboundRelationship(typeCode=COMP].source[classCode<=PCPR, moodCode=EVN]"
},
{
"identity" : "quick",
"map" : "ClinicalStatement.encounter"
}]
},
{
"id" : "ServiceRequest.occurrence[x]",
"path" : "ServiceRequest.occurrence[x]",
"short" : "When service should occur",
"definition" : "The date/time at which the requested service should occur.",
"alias" : ["schedule"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "ServiceRequest.occurrence[x]",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
},
{
"code" : "Period"
},
{
"code" : "Timing"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.occurrence[x]"
},
{
"identity" : "w5",
"map" : "FiveWs.planned"
},
{
"identity" : "v2",
"map" : "TQ1/TQ2, OBR-7/OBR-8"
},
{
"identity" : "rim",
"map" : ".effectiveTime"
},
{
"identity" : "quick",
"map" : "Procedure.procedureSchedule"
}]
},
{
"id" : "ServiceRequest.asNeeded[x]",
"path" : "ServiceRequest.asNeeded[x]",
"short" : "Preconditions for service",
"definition" : "If a CodeableConcept is present, it indicates the pre-condition for performing the service. For example \"pain\", \"on flare-up\", etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ServiceRequest.asNeeded[x]",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
},
{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ProcedureAsNeededReason"
}],
"strength" : "example",
"description" : "A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example \"pain\", \"on flare-up\", etc.",
"valueSet" : "http://hl7.org/fhir/ValueSet/medication-as-needed-reason"
},
"mapping" : [{
"identity" : "rim",
"map" : "boolean: precondition.negationInd (inversed - so negationInd = true means asNeeded=false CodeableConcept: precondition.observationEventCriterion[code=\"Assertion\"].value"
},
{
"identity" : "quick",
"map" : "Proposal.prnReason.reason"
}]
},
{
"id" : "ServiceRequest.authoredOn",
"path" : "ServiceRequest.authoredOn",
"short" : "Date request signed",
"definition" : "When the request transitioned to being actionable.",
"alias" : ["orderedOn"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "ServiceRequest.authoredOn",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.authoredOn"
},
{
"identity" : "w5",
"map" : "FiveWs.recorded"
},
{
"identity" : "v2",
"map" : "ORC.9, RF1-7 / RF1-9"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=AUT].time"
},
{
"identity" : "quick",
"map" : "Proposal.proposedAtTime"
}]
},
{
"id" : "ServiceRequest.requester",
"path" : "ServiceRequest.requester",
"short" : "Who/what is requesting service",
"definition" : "The individual who initiated the request and has responsibility for its activation.",
"comment" : "This not the dispatcher, but rather who is the authorizer. This element is not intended to handle delegation which would generally be managed through the Provenance resource.",
"alias" : ["author",
"orderer"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "ServiceRequest.requester",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Organization",
"http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson",
"http://hl7.org/fhir/StructureDefinition/Device"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.requester"
},
{
"identity" : "w5",
"map" : "FiveWs.author"
},
{
"identity" : "v2",
"map" : "ORC.12, PRT"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=AUT].role"
},
{
"identity" : "quick",
"map" : "ClinicalStatement.statementAuthor"
}]
},
{
"id" : "ServiceRequest.performerType",
"path" : "ServiceRequest.performerType",
"short" : "Performer role",
"definition" : "Desired type of performer for doing the requested service.",
"comment" : "This is a role, not a participation type. In other words, does not describe the task but describes the capacity. For example, “compounding pharmacy”, “psychiatrist” or “internal referral”.",
"alias" : ["specialty"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "ServiceRequest.performerType",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ServiceRequestParticipantRole"
}],
"strength" : "example",
"description" : "Indicates specific responsibility of an individual within the care team, such as \"Primary physician\", \"Team coordinator\", \"Caregiver\", etc.",
"valueSet" : "http://hl7.org/fhir/ValueSet/participant-role"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.performerType"
},
{
"identity" : "w5",
"map" : "FiveWs.actor"
},
{
"identity" : "v2",
"map" : "PRT, RF!-3"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=PRF].role[scoper.determinerCode=KIND].code"
}]
},
{
"id" : "ServiceRequest.performer",
"path" : "ServiceRequest.performer",
"short" : "Requested performer",
"definition" : "The desired performer for doing the requested service. For example, the surgeon, dermatopathologist, endoscopist, etc.",
"comment" : "If multiple performers are present, it is interpreted as a list of *alternative* performers without any preference regardless of order. If order of preference is needed use the [request-performerOrder extension](extension-request-performerorder.html). Use CareTeam to represent a group of performers (for example, Practitioner A *and* Practitioner B).",
"alias" : ["request recipient"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "ServiceRequest.performer",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Organization",
"http://hl7.org/fhir/StructureDefinition/CareTeam",
"http://hl7.org/fhir/StructureDefinition/HealthcareService",
"http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Device",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.performer"
},
{
"identity" : "w5",
"map" : "FiveWs.actor"
},
{
"identity" : "v2",
"map" : "PRT, Practitioner: PRD-2/PRD-7 where PRD-3 = RT; Organization: PRD-10 where PRD-3 = RT"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]"
}]
},
{
"id" : "ServiceRequest.locationCode",
"path" : "ServiceRequest.locationCode",
"short" : "Requested location",
"definition" : "The preferred location(s) where the procedure should actually happen in coded or free text form. E.g. at home or nursing day care center.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ServiceRequest.locationCode",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ServiceRequestLocation"
}],
"strength" : "example",
"description" : "A location type where services are delivered.",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.actor"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=LOC].role[scoper.determinerCode=KIND].code"
}]
},
{
"id" : "ServiceRequest.locationReference",
"path" : "ServiceRequest.locationReference",
"short" : "Requested location",
"definition" : "A reference to the the preferred location(s) where the procedure should actually happen. E.g. at home or nursing day care center.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ServiceRequest.locationReference",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Location"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.actor"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=LOC].role[scoper.determinerCode=INSTANCE]"
}]
},
{
"id" : "ServiceRequest.reasonCode",
"path" : "ServiceRequest.reasonCode",
"short" : "Explanation/Justification for procedure or service",
"definition" : "An explanation or justification for why this service is being requested in coded or textual form. This is often for billing purposes. May relate to the resources referred to in `supportingInfo`.",
"comment" : "This element represents why the referral is being made and may be used to decide how the service will be performed, or even if it will be performed at all. Use `CodeableConcept.text` element if the data is free (uncoded) text as shown in the [CT Scan example](servicerequest-example-di.html).",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ServiceRequest.reasonCode",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ServiceRequestReason"
}],
"strength" : "example",
"description" : "Diagnosis or problem codes justifying the reason for requesting the service investigation.",
"valueSet" : "http://hl7.org/fhir/ValueSet/procedure-reason"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.reasonCode"
},
{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "v2",
"map" : "ORC.16, RF1-10"
},
{
"identity" : "rim",
"map" : ".reasonCode"
}]
},
{
"id" : "ServiceRequest.reasonReference",
"path" : "ServiceRequest.reasonReference",
"short" : "Explanation/Justification for service or service",
"definition" : "Indicates another resource that provides a justification for why this service is being requested. May relate to the resources referred to in `supportingInfo`.",
"comment" : "This element represents why the referral is being made and may be used to decide how the service will be performed, or even if it will be performed at all. To be as specific as possible, a reference to *Observation* or *Condition* should be used if available. Otherwise when referencing *DiagnosticReport* it should contain a finding in `DiagnosticReport.conclusion` and/or `DiagnosticReport.conclusionCode`. When using a reference to *DocumentReference*, the target document should contain clear findings language providing the relevant reason for this service request. Use the CodeableConcept text element in `ServiceRequest.reasonCode` if the data is free (uncoded) text as shown in the [CT Scan example](servicerequest-example-di.html).",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ServiceRequest.reasonReference",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Condition",
"http://hl7.org/fhir/StructureDefinition/Observation",
"http://hl7.org/fhir/StructureDefinition/DiagnosticReport",
"http://hl7.org/fhir/StructureDefinition/DocumentReference"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.reasonReference"
},
{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "v2",
"map" : "ORC.16"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=RSON].target"
}]
},
{
"id" : "ServiceRequest.insurance",
"path" : "ServiceRequest.insurance",
"short" : "Associated insurance coverage",
"definition" : "Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be needed for delivering the requested service.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ServiceRequest.insurance",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Coverage",
"http://hl7.org/fhir/StructureDefinition/ClaimResponse"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.insurance"
},
{
"identity" : "v2",
"map" : "IN1/IN2"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=COVBY].target"
}]
},
{
"id" : "ServiceRequest.supportingInfo",
"path" : "ServiceRequest.supportingInfo",
"short" : "Additional clinical information",
"definition" : "Additional clinical information about the patient or specimen that may influence the services or their interpretations. This information includes diagnosis, clinical findings and other observations. In laboratory ordering these are typically referred to as \"ask at order entry questions (AOEs)\". This includes observations explicitly requested by the producer (filler) to provide context or supporting information needed to complete the order. For example, reporting the amount of inspired oxygen for blood gas measurements.",
"comment" : "To represent information about how the services are to be delivered use the `instructions` element.",
"alias" : ["Ask at order entry question",
"AOE"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "ServiceRequest.supportingInfo",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.supportingInfo"
},
{
"identity" : "v2",
"map" : "Accompanying segments"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=PERT].target"
}]
},
{
"id" : "ServiceRequest.specimen",
"path" : "ServiceRequest.specimen",
"short" : "Procedure Samples",
"definition" : "One or more specimens that the laboratory procedure will use.",
"comment" : "Many diagnostic procedures need a specimen, but the request itself is not actually about the specimen. This element is for when the diagnostic is requested on already existing specimens and the request points to the specimen it applies to. Conversely, if the request is entered first with an unknown specimen, then the [Specimen](specimen.html) resource points to the ServiceRequest.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ServiceRequest.specimen",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Specimen"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "v2",
"map" : "SPM"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=SPC].role"
}]
},
{
"id" : "ServiceRequest.bodySite",
"path" : "ServiceRequest.bodySite",
"short" : "Location on Body",
"definition" : "Anatomic location where the procedure should be performed. This is the target site.",
"comment" : "Only used if not implicit in the code found in ServiceRequest.code. If the use case requires BodySite to be handled as a separate resource instead of an inline coded element (e.g. to identify and track separately) then use the standard extension [procedure-targetBodyStructure](extension-procedure-targetbodystructure.html).",
"requirements" : "Knowing where the procedure is performed is important for tracking if multiple sites are possible.",
"alias" : ["location"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "ServiceRequest.bodySite",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "BodySite"
}],
"strength" : "example",
"description" : "Codes describing anatomical locations. May include laterality.",
"valueSet" : "http://hl7.org/fhir/ValueSet/body-site"
},
"mapping" : [{
"identity" : "v2",
"map" : "SPM"
},
{
"identity" : "rim",
"map" : "targetSiteCode"
},
{
"identity" : "quick",
"map" : "Procedure.targetBodySite"
}]
},
{
"id" : "ServiceRequest.note",
"path" : "ServiceRequest.note",
"short" : "Comments",
"definition" : "Any other notes and comments made about the service request. For example, internal billing notes.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ServiceRequest.note",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Annotation"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.note"
},
{
"identity" : "v2",
"map" : "NTE"
},
{
"identity" : "rim",
"map" : ".inboundRelationship(typeCode=SUBJ].source[classCode=ANNGEN, moodCode=EVN].value[xsi:type=ST]"
},
{
"identity" : "quick",
"map" : "ClinicalStatement.additionalText"
}]
},
{
"id" : "ServiceRequest.patientInstruction",
"path" : "ServiceRequest.patientInstruction",
"short" : "Patient or consumer-oriented instructions",
"definition" : "Instructions in terms that are understood by the patient or consumer.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ServiceRequest.patientInstruction",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "v2",
"map" : "NTE"
},
{
"identity" : "rim",
"map" : ".text"
}]
},
{
"id" : "ServiceRequest.relevantHistory",
"path" : "ServiceRequest.relevantHistory",
"short" : "Request provenance",
"definition" : "Key events in the history of the request.",
"comment" : "This might not include provenances for all versions of the request – only those deemed “relevant” or important.\rThis SHALL NOT include the Provenance associated with this current version of the resource. (If that provenance is deemed to be a “relevant” change, it will need to be added as part of a later update. Until then, it can be queried directly as the Provenance that points to this version using _revinclude\rAll Provenances should have some historical version of this Request as their subject.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ServiceRequest.relevantHistory",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Provenance"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.relevantHistory"
},
{
"identity" : "v2",
"map" : "N/A"
},
{
"identity" : "rim",
"map" : ".inboundRelationship(typeCode=SUBJ].source[classCode=CACT, moodCode=EVN]"
}]
}]
},
"differential" : {
"element" : [{
"id" : "ServiceRequest",
"path" : "ServiceRequest",
"short" : "A request for a service to be performed",
"definition" : "A record of a request for service such as diagnostic investigations, treatments, or operations to be performed.",
"alias" : ["diagnostic request",
"referral",
"referral request",
"transfer of care request"],
"min" : 0,
"max" : "*",
"constraint" : [{
"key" : "prr-1",
"severity" : "error",
"human" : "orderDetail SHALL only be present if code is present",
"expression" : "orderDetail.empty() or code.exists()",
"xpath" : "exists(f:code) or not(exists(f:orderDetail))"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Request"
},
{
"identity" : "v2",
"map" : "ORC"
},
{
"identity" : "rim",
"map" : "Act[moodCode<=INT]"
}]
},
{
"id" : "ServiceRequest.identifier",
"path" : "ServiceRequest.identifier",
"short" : "Identifiers assigned to this order",
"definition" : "Identifiers assigned to this order instance by the orderer and/or the receiver and/or order fulfiller.",
"comment" : "The identifier.type element is used to distinguish between the identifiers assigned by the orderer (known as the 'Placer' in HL7 v2) and the producer of the observations in response to the order (known as the 'Filler' in HL7 v2). For further discussion and examples see the resource notes section below.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Identifier"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.identifier"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "v2",
"map" : "ORC.2, ORC.3, RF1-6 / RF1-11,"
},
{
"identity" : "rim",
"map" : ".identifier"
},
{
"identity" : "quick",
"map" : "ClinicalStatement.identifier"
}]
},
{
"id" : "ServiceRequest.instantiatesCanonical",
"path" : "ServiceRequest.instantiatesCanonical",
"short" : "Instantiates FHIR protocol or definition",
"definition" : "The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this ServiceRequest.",
"comment" : "Note: This is a business identifier, not a resource identifier (see [discussion](resource.html#identifiers)). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ActivityDefinition",
"http://hl7.org/fhir/StructureDefinition/PlanDefinition"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.instantiatesCanonical"
},
{
"identity" : "v2",
"map" : "Varies by domain"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=DEFN].target"
}]
},
{
"id" : "ServiceRequest.instantiatesUri",
"path" : "ServiceRequest.instantiatesUri",
"short" : "Instantiates external protocol or definition",
"definition" : "The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this ServiceRequest.",
"comment" : "This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "uri"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.instantiatesUri"
},
{
"identity" : "v2",
"map" : "Varies by domain"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=DEFN].target"
}]
},
{
"id" : "ServiceRequest.basedOn",
"path" : "ServiceRequest.basedOn",
"short" : "What request fulfills",
"definition" : "Plan/proposal/order fulfilled by this request.",
"alias" : ["fulfills"],
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/CarePlan",
"http://hl7.org/fhir/StructureDefinition/ServiceRequest",
"http://hl7.org/fhir/StructureDefinition/MedicationRequest"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.basedOn"
},
{
"identity" : "v2",
"map" : "ORC.8 (plus others)"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=FLFS].target"
}]
},
{
"id" : "ServiceRequest.replaces",
"path" : "ServiceRequest.replaces",
"short" : "What request replaces",
"definition" : "The request takes the place of the referenced completed or terminated request(s).",
"alias" : ["supersedes",
"prior",
"renewed order"],
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ServiceRequest"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.replaces"
},
{
"identity" : "v2",
"map" : "Handled by message location of ORC (ORC.1=RO or RU)"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=RPLC].target"
}]
},
{
"id" : "ServiceRequest.requisition",
"path" : "ServiceRequest.requisition",
"short" : "Composite Request ID",
"definition" : "A shared identifier common to all service requests that were authorized more or less simultaneously by a single author, representing the composite or group identifier.",
"comment" : "Requests are linked either by a \"basedOn\" relationship (i.e. one request is fulfilling another) or by having a common requisition. Requests that are part of the same requisition are generally treated independently from the perspective of changing their state or maintaining them after initial creation.",
"requirements" : "Some business processes need to know if multiple items were ordered as part of the same \"requisition\" for billing or other purposes.",
"alias" : ["grouperId",
"groupIdentifier"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Identifier"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.groupIdentifier"
},
{
"identity" : "v2",
"map" : "ORC.4"
},
{
"identity" : "rim",
"map" : ".inboundRelationship(typeCode=COMP].source[moodCode=INT].identifier"
}]
},
{
"id" : "ServiceRequest.status",
"path" : "ServiceRequest.status",
"short" : "draft | active | on-hold | revoked | completed | entered-in-error | unknown",
"definition" : "The status of the order.",
"comment" : "The status is generally fully in the control of the requester - they determine whether the order is draft or active and, after it has been activated, competed, cancelled or suspended. States relating to the activities of the performer are reflected on either the corresponding event (see [Event Pattern](event.html) for general discussion) or using the [Task](task.html) resource.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ServiceRequestStatus"
}],
"strength" : "required",
"description" : "The status of a service order.",
"valueSet" : "http://hl7.org/fhir/ValueSet/request-status|4.0.1"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.status"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
},
{
"identity" : "v2",
"map" : "ORC.5,RF1-1"
},
{
"identity" : "rim",
"map" : ".status"
},
{
"identity" : "quick",
"map" : "Action.currentStatus"
}]
},
{
"id" : "ServiceRequest.intent",
"path" : "ServiceRequest.intent",
"short" : "proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option",
"definition" : "Whether the request is a proposal, plan, an original order or a reflex order.",
"comment" : "This element is labeled as a modifier because the intent alters when and how the resource is actually applicable.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isModifier" : true,
"isModifierReason" : "This element changes the interpretation of all descriptive attributes. For example \"the time the request is recommended to occur\" vs. \"the time the request is authorized to occur\" or \"who is recommended to perform the request\" vs. \"who is authorized to perform the request",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ServiceRequestIntent"
}],
"strength" : "required",
"description" : "The kind of service request.",
"valueSet" : "http://hl7.org/fhir/ValueSet/request-intent|4.0.1"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.intent"
},
{
"identity" : "w5",
"map" : "FiveWs.class"
},
{
"identity" : "v2",
"map" : "N/A"
},
{
"identity" : "rim",
"map" : ".moodCode (nuances beyond PRP/PLAN/RQO would need to be elsewhere)"
}]
},
{
"id" : "ServiceRequest.category",
"path" : "ServiceRequest.category",
"short" : "Classification of service",
"definition" : "A code that classifies the service for searching, sorting and display purposes (e.g. \"Surgical Procedure\").",
"comment" : "There may be multiple axis of categorization depending on the context or use case for retrieving or displaying the resource. The level of granularity is defined by the category concepts in the value set.",
"requirements" : "Used for filtering what service request are retrieved and displayed.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ServiceRequestCategory"
}],
"strength" : "example",
"description" : "Classification of the requested service.",
"valueSet" : "http://hl7.org/fhir/ValueSet/servicerequest-category"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.class"
},
{
"identity" : "v2",
"map" : "RF1-5"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=\"COMP].target[classCode=\"LIST\", moodCode=\"INT\"].code"
}]
},
{
"id" : "ServiceRequest.priority",
"path" : "ServiceRequest.priority",
"short" : "routine | urgent | asap | stat",
"definition" : "Indicates how quickly the ServiceRequest should be addressed with respect to other requests.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "code"
}],
"meaningWhenMissing" : "If missing, this task should be performed with normal priority",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ServiceRequestPriority"
}],
"strength" : "required",
"description" : "Identifies the level of importance to be assigned to actioning the request.",
"valueSet" : "http://hl7.org/fhir/ValueSet/request-priority|4.0.1"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.priority"
},
{
"identity" : "w5",
"map" : "FiveWs.grade"
},
{
"identity" : "v2",
"map" : "TQ1.9, RF1-2"
},
{
"identity" : "rim",
"map" : ".priorityCode"
}]
},
{
"id" : "ServiceRequest.doNotPerform",
"path" : "ServiceRequest.doNotPerform",
"short" : "True if service/procedure should not be performed",
"definition" : "Set this to true if the record is saying that the service/procedure should NOT be performed.",
"comment" : "In general, only the code and timeframe will be present, though occasional additional qualifiers such as body site or even performer could be included to narrow the scope of the prohibition. If the ServiceRequest.code and ServiceRequest.doNotPerform both contain negation, that will reinforce prohibition and should not have a double negative interpretation.",
"requirements" : "Used for do not ambulate, do not elevate head of bed, do not flush NG tube, do not take blood pressure on a certain arm, etc.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "boolean"
}],
"meaningWhenMissing" : "If missing, the request is a positive request e.g. \"do perform\"",
"isModifier" : true,
"isModifierReason" : "If true this element negates the specified action. For Example, instead of a request for a procedure, it is a request for the procedure to not occur.",
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.doNotPerform"
},
{
"identity" : "rim",
"map" : ".actionNegationInd"
}]
},
{
"id" : "ServiceRequest.code",
"path" : "ServiceRequest.code",
"short" : "What is being requested/ordered",
"definition" : "A code that identifies a particular service (i.e., procedure, diagnostic investigation, or panel of investigations) that have been requested.",
"comment" : "Many laboratory and radiology procedure codes embed the specimen/organ system in the test order name, for example, serum or serum/plasma glucose, or a chest x-ray. The specimen might not be recorded separately from the test code.",
"alias" : ["service requested"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ServiceRequestCode"
}],
"strength" : "example",
"description" : "Codes for tests or services that can be carried out by a designated individual, organization or healthcare service. For laboratory, LOINC is (preferred)[http://build.fhir.org/terminologies.html#preferred] and a valueset using LOINC Order codes is available [here](valueset-diagnostic-requests.html).",
"valueSet" : "http://hl7.org/fhir/ValueSet/procedure-code"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.code"
},
{
"identity" : "w5",
"map" : "FiveWs.what[x]"
},
{
"identity" : "v2",
"map" : "PR1-3 / OBR-4 (varies by domain)"
},
{
"identity" : "rim",
"map" : ".code"
},
{
"identity" : "quick",
"map" : "Procedure.procedureCode"
}]
},
{
"id" : "ServiceRequest.orderDetail",
"path" : "ServiceRequest.orderDetail",
"short" : "Additional order information",
"definition" : "Additional details and instructions about the how the services are to be delivered. For example, and order for a urinary catheter may have an order detail for an external or indwelling catheter, or an order for a bandage may require additional instructions specifying how the bandage should be applied.",
"comment" : "For information from the medical record intended to support the delivery of the requested services, use the `supportingInformation` element.",
"alias" : ["detailed instructions"],
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"condition" : ["prr-1"],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "OrderDetail"
}],
"strength" : "example",
"description" : "Codified order entry details which are based on order context.",
"valueSet" : "http://hl7.org/fhir/ValueSet/servicerequest-orderdetail"
},
"mapping" : [{
"identity" : "v2",
"map" : "NTE"
},
{
"identity" : "rim",
"map" : ".code"
},
{
"identity" : "quick",
"map" : "Procedure.procedureCode"
}]
},
{
"id" : "ServiceRequest.quantity[x]",
"path" : "ServiceRequest.quantity[x]",
"short" : "Service amount",
"definition" : "An amount of service being requested which can be a quantity ( for example $1,500 home modification), a ratio ( for example, 20 half day visits per month), or a range (2.0 to 1.8 Gy per fraction).",
"requirements" : "When ordering a service the number of service items may need to be specified separately from the the service item.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Quantity"
},
{
"code" : "Ratio"
},
{
"code" : "Range"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "v2",
"map" : "NTE"
},
{
"identity" : "rim",
"map" : ".quantity"
}]
},
{
"id" : "ServiceRequest.subject",
"path" : "ServiceRequest.subject",
"short" : "Individual or Entity the service is ordered for",
"definition" : "On whom or what the service is to be performed. This is usually a human patient, but can also be requested on animals, groups of humans or animals, devices such as dialysis machines, or even locations (typically for environmental scans).",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Group",
"http://hl7.org/fhir/StructureDefinition/Location",
"http://hl7.org/fhir/StructureDefinition/Device"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.subject"
},
{
"identity" : "w5",
"map" : "FiveWs.subject[x]"
},
{
"identity" : "v2",
"map" : "PID"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=SBJ].role"
},
{
"identity" : "quick",
"map" : "ClinicalStatement.subject"
},
{
"identity" : "w5",
"map" : "FiveWs.subject"
}]
},
{
"id" : "ServiceRequest.encounter",
"path" : "ServiceRequest.encounter",
"short" : "Encounter in which the request was created",
"definition" : "An encounter that provides additional information about the healthcare context in which this request is made.",
"alias" : ["context"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Encounter"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.encounter"
},
{
"identity" : "w5",
"map" : "FiveWs.context"
},
{
"identity" : "v2",
"map" : "PV1"
},
{
"identity" : "rim",
"map" : ".inboundRelationship(typeCode=COMP].source[classCode<=PCPR, moodCode=EVN]"
},
{
"identity" : "quick",
"map" : "ClinicalStatement.encounter"
}]
},
{
"id" : "ServiceRequest.occurrence[x]",
"path" : "ServiceRequest.occurrence[x]",
"short" : "When service should occur",
"definition" : "The date/time at which the requested service should occur.",
"alias" : ["schedule"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "dateTime"
},
{
"code" : "Period"
},
{
"code" : "Timing"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.occurrence[x]"
},
{
"identity" : "w5",
"map" : "FiveWs.planned"
},
{
"identity" : "v2",
"map" : "TQ1/TQ2, OBR-7/OBR-8"
},
{
"identity" : "rim",
"map" : ".effectiveTime"
},
{
"identity" : "quick",
"map" : "Procedure.procedureSchedule"
}]
},
{
"id" : "ServiceRequest.asNeeded[x]",
"path" : "ServiceRequest.asNeeded[x]",
"short" : "Preconditions for service",
"definition" : "If a CodeableConcept is present, it indicates the pre-condition for performing the service. For example \"pain\", \"on flare-up\", etc.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "boolean"
},
{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ProcedureAsNeededReason"
}],
"strength" : "example",
"description" : "A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example \"pain\", \"on flare-up\", etc.",
"valueSet" : "http://hl7.org/fhir/ValueSet/medication-as-needed-reason"
},
"mapping" : [{
"identity" : "rim",
"map" : "boolean: precondition.negationInd (inversed - so negationInd = true means asNeeded=false CodeableConcept: precondition.observationEventCriterion[code=\"Assertion\"].value"
},
{
"identity" : "quick",
"map" : "Proposal.prnReason.reason"
}]
},
{
"id" : "ServiceRequest.authoredOn",
"path" : "ServiceRequest.authoredOn",
"short" : "Date request signed",
"definition" : "When the request transitioned to being actionable.",
"alias" : ["orderedOn"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "dateTime"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.authoredOn"
},
{
"identity" : "w5",
"map" : "FiveWs.recorded"
},
{
"identity" : "v2",
"map" : "ORC.9, RF1-7 / RF1-9"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=AUT].time"
},
{
"identity" : "quick",
"map" : "Proposal.proposedAtTime"
}]
},
{
"id" : "ServiceRequest.requester",
"path" : "ServiceRequest.requester",
"short" : "Who/what is requesting service",
"definition" : "The individual who initiated the request and has responsibility for its activation.",
"comment" : "This not the dispatcher, but rather who is the authorizer. This element is not intended to handle delegation which would generally be managed through the Provenance resource.",
"alias" : ["author",
"orderer"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Organization",
"http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson",
"http://hl7.org/fhir/StructureDefinition/Device"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.requester"
},
{
"identity" : "w5",
"map" : "FiveWs.author"
},
{
"identity" : "v2",
"map" : "ORC.12, PRT"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=AUT].role"
},
{
"identity" : "quick",
"map" : "ClinicalStatement.statementAuthor"
}]
},
{
"id" : "ServiceRequest.performerType",
"path" : "ServiceRequest.performerType",
"short" : "Performer role",
"definition" : "Desired type of performer for doing the requested service.",
"comment" : "This is a role, not a participation type. In other words, does not describe the task but describes the capacity. For example, “compounding pharmacy”, “psychiatrist” or “internal referral”.",
"alias" : ["specialty"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ServiceRequestParticipantRole"
}],
"strength" : "example",
"description" : "Indicates specific responsibility of an individual within the care team, such as \"Primary physician\", \"Team coordinator\", \"Caregiver\", etc.",
"valueSet" : "http://hl7.org/fhir/ValueSet/participant-role"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.performerType"
},
{
"identity" : "w5",
"map" : "FiveWs.actor"
},
{
"identity" : "v2",
"map" : "PRT, RF!-3"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=PRF].role[scoper.determinerCode=KIND].code"
}]
},
{
"id" : "ServiceRequest.performer",
"path" : "ServiceRequest.performer",
"short" : "Requested performer",
"definition" : "The desired performer for doing the requested service. For example, the surgeon, dermatopathologist, endoscopist, etc.",
"comment" : "If multiple performers are present, it is interpreted as a list of *alternative* performers without any preference regardless of order. If order of preference is needed use the [request-performerOrder extension](extension-request-performerorder.html). Use CareTeam to represent a group of performers (for example, Practitioner A *and* Practitioner B).",
"alias" : ["request recipient"],
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Organization",
"http://hl7.org/fhir/StructureDefinition/CareTeam",
"http://hl7.org/fhir/StructureDefinition/HealthcareService",
"http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Device",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.performer"
},
{
"identity" : "w5",
"map" : "FiveWs.actor"
},
{
"identity" : "v2",
"map" : "PRT, Practitioner: PRD-2/PRD-7 where PRD-3 = RT; Organization: PRD-10 where PRD-3 = RT"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]"
}]
},
{
"id" : "ServiceRequest.locationCode",
"path" : "ServiceRequest.locationCode",
"short" : "Requested location",
"definition" : "The preferred location(s) where the procedure should actually happen in coded or free text form. E.g. at home or nursing day care center.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ServiceRequestLocation"
}],
"strength" : "example",
"description" : "A location type where services are delivered.",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.actor"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=LOC].role[scoper.determinerCode=KIND].code"
}]
},
{
"id" : "ServiceRequest.locationReference",
"path" : "ServiceRequest.locationReference",
"short" : "Requested location",
"definition" : "A reference to the the preferred location(s) where the procedure should actually happen. E.g. at home or nursing day care center.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Location"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.actor"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=LOC].role[scoper.determinerCode=INSTANCE]"
}]
},
{
"id" : "ServiceRequest.reasonCode",
"path" : "ServiceRequest.reasonCode",
"short" : "Explanation/Justification for procedure or service",
"definition" : "An explanation or justification for why this service is being requested in coded or textual form. This is often for billing purposes. May relate to the resources referred to in `supportingInfo`.",
"comment" : "This element represents why the referral is being made and may be used to decide how the service will be performed, or even if it will be performed at all. Use `CodeableConcept.text` element if the data is free (uncoded) text as shown in the [CT Scan example](servicerequest-example-di.html).",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ServiceRequestReason"
}],
"strength" : "example",
"description" : "Diagnosis or problem codes justifying the reason for requesting the service investigation.",
"valueSet" : "http://hl7.org/fhir/ValueSet/procedure-reason"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.reasonCode"
},
{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "v2",
"map" : "ORC.16, RF1-10"
},
{
"identity" : "rim",
"map" : ".reasonCode"
}]
},
{
"id" : "ServiceRequest.reasonReference",
"path" : "ServiceRequest.reasonReference",
"short" : "Explanation/Justification for service or service",
"definition" : "Indicates another resource that provides a justification for why this service is being requested. May relate to the resources referred to in `supportingInfo`.",
"comment" : "This element represents why the referral is being made and may be used to decide how the service will be performed, or even if it will be performed at all. To be as specific as possible, a reference to *Observation* or *Condition* should be used if available. Otherwise when referencing *DiagnosticReport* it should contain a finding in `DiagnosticReport.conclusion` and/or `DiagnosticReport.conclusionCode`. When using a reference to *DocumentReference*, the target document should contain clear findings language providing the relevant reason for this service request. Use the CodeableConcept text element in `ServiceRequest.reasonCode` if the data is free (uncoded) text as shown in the [CT Scan example](servicerequest-example-di.html).",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Condition",
"http://hl7.org/fhir/StructureDefinition/Observation",
"http://hl7.org/fhir/StructureDefinition/DiagnosticReport",
"http://hl7.org/fhir/StructureDefinition/DocumentReference"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.reasonReference"
},
{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "v2",
"map" : "ORC.16"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=RSON].target"
}]
},
{
"id" : "ServiceRequest.insurance",
"path" : "ServiceRequest.insurance",
"short" : "Associated insurance coverage",
"definition" : "Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be needed for delivering the requested service.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Coverage",
"http://hl7.org/fhir/StructureDefinition/ClaimResponse"]
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Request.insurance"
},
{
"identity" : "v2",
"map" : "IN1/IN2"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=COVBY].target"
}]
},
{
"id" : "ServiceRequest.supportingInfo",
"path" : "ServiceRequest.supportingInfo",
"short" : "Additional clinical information",
"definition" : "Additional clinical information about the patient or specimen that may influence the services or their interpretations. This information includes diagnosis, clinical findings and other observations. In laboratory ordering these are typically referred to as \"ask at order entry questions (AOEs)\". This includes observations explicitly requested by the producer (filler) to provide context or supporting information needed to complete the order. For example, reporting the amount of inspired oxygen for blood gas measurements.",
"comment" : "To represent information about how the services are to be delivered use the `instructions` element.",
"alias" : ["Ask at order entry question",
"AOE"],
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Request.supportingInfo"
},
{
"identity" : "v2",
"map" : "Accompanying segments"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=PERT].target"
}]
},
{
"id" : "ServiceRequest.specimen",
"path" : "ServiceRequest.specimen",
"short" : "Procedure Samples",
"definition" : "One or more specimens that the laboratory procedure will use.",
"comment" : "Many diagnostic procedures need a specimen, but the request itself is not actually about the specimen. This element is for when the diagnostic is requested on already existing specimens and the request points to the specimen it applies to. Conversely, if the request is entered first with an unknown specimen, then the [Specimen](specimen.html) resource points to the ServiceRequest.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Specimen"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "v2",
"map" : "SPM"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=SPC].role"
}]
},
{
"id" : "ServiceRequest.bodySite",
"path" : "ServiceRequest.bodySite",
"short" : "Location on Body",
"definition" : "Anatomic location where the procedure should be performed. This is the target site.",
"comment" : "Only used if not implicit in the code found in ServiceRequest.code. If the use case requires BodySite to be handled as a separate resource instead of an inline coded element (e.g. to identify and track separately) then use the standard extension [procedure-targetBodyStructure](extension-procedure-targetbodystructure.html).",
"requirements" : "Knowing where the procedure is performed is important for tracking if multiple sites are possible.",
"alias" : ["location"],
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "BodySite"
}],
"strength" : "example",
"description" : "Codes describing anatomical locations. May include laterality.",
"valueSet" : "http://hl7.org/fhir/ValueSet/body-site"
},
"mapping" : [{
"identity" : "v2",
"map" : "SPM"
},
{
"identity" : "rim",
"map" : "targetSiteCode"
},
{
"identity" : "quick",
"map" : "Procedure.targetBodySite"
}]
},
{
"id" : "ServiceRequest.note",
"path" : "ServiceRequest.note",
"short" : "Comments",
"definition" : "Any other notes and comments made about the service request. For example, internal billing notes.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Annotation"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Request.note"
},
{
"identity" : "v2",
"map" : "NTE"
},
{
"identity" : "rim",
"map" : ".inboundRelationship(typeCode=SUBJ].source[classCode=ANNGEN, moodCode=EVN].value[xsi:type=ST]"
},
{
"identity" : "quick",
"map" : "ClinicalStatement.additionalText"
}]
},
{
"id" : "ServiceRequest.patientInstruction",
"path" : "ServiceRequest.patientInstruction",
"short" : "Patient or consumer-oriented instructions",
"definition" : "Instructions in terms that are understood by the patient or consumer.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "v2",
"map" : "NTE"
},
{
"identity" : "rim",
"map" : ".text"
}]
},
{
"id" : "ServiceRequest.relevantHistory",
"path" : "ServiceRequest.relevantHistory",
"short" : "Request provenance",
"definition" : "Key events in the history of the request.",
"comment" : "This might not include provenances for all versions of the request – only those deemed “relevant” or important.\rThis SHALL NOT include the Provenance associated with this current version of the resource. (If that provenance is deemed to be a “relevant” change, it will need to be added as part of a later update. Until then, it can be queried directly as the Provenance that points to this version using _revinclude\rAll Provenances should have some historical version of this Request as their subject.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Provenance"]
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Request.relevantHistory"
},
{
"identity" : "v2",
"map" : "N/A"
},
{
"identity" : "rim",
"map" : ".inboundRelationship(typeCode=SUBJ].source[classCode=CACT, moodCode=EVN]"
}]
}]
}
}
},
{
"fullUrl" : "http://hl7.org/fhir/StructureDefinition/Slot",
"resource" : {
"resourceType" : "StructureDefinition",
"id" : "Slot",
"meta" : {
"lastUpdated" : "2019-11-01T09:29:23.356+11:00"
},
"text" : {
"status" : "generated",
"div" : "Name Flags Card. Type Description & Constraints Slot 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 identifier Σ 0..* Identifier External Ids for this item
serviceCategory Σ 0..* CodeableConcept A broad categorization of the service that is to be performed during this appointment
Service category (Example)
serviceType Σ 0..* CodeableConcept The type of appointments that can be booked into this slot (ideally this would be an identifiable service - which is at a location, rather than the location itself). If provided then this overrides the value provided on the availability resource
Service type (Example)
specialty Σ 0..* CodeableConcept The specialty of a practitioner that would be required to perform the service requested in this appointment
Practice Setting Code Value Set (Preferred)
appointmentType Σ 0..1 CodeableConcept The style of appointment or patient that may be booked in the slot (not service type)
v2 Appointment Reason Codes (Preferred) schedule Σ 1..1 Reference(Schedule) The schedule resource that this slot defines an interval of status information status Σ 1..1 code busy | free | busy-unavailable | busy-tentative | entered-in-error
SlotStatus (Required) start Σ 1..1 instant Date/Time that the slot is to begin end Σ 1..1 instant Date/Time that the slot is to conclude overbooked 0..1 boolean This slot has already been overbooked, appointments are unlikely to be accepted for this time comment 0..1 string Comments on the slot to describe any extended information. Such as custom constraints on the slot
Documentation for this format
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Base.Workflow"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 3
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "business"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "pa"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/Slot",
"version" : "4.0.1",
"name" : "Slot",
"status" : "draft",
"date" : "2019-11-01T09:29:23+11:00",
"publisher" : "Health Level Seven International (Patient Administration)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/pafm/index.cfm"
}]
}],
"description" : "A slot of time on a schedule that may be available for booking appointments.",
"fhirVersion" : "4.0.1",
"mapping" : [{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
},
{
"identity" : "ical",
"uri" : "http://ietf.org/rfc/2445",
"name" : "iCalendar"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/fivews",
"name" : "FiveWs Pattern Mapping"
}],
"kind" : "resource",
"abstract" : false,
"type" : "Slot",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "Slot",
"path" : "Slot",
"short" : "A slot of time on a schedule that may be available for booking appointments",
"definition" : "A slot of time on a schedule that may be available for booking appointments.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Slot",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "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",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.`div`.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "ical",
"map" : "(refer to the Availability resource for the header mapping details)"
}]
},
{
"id" : "Slot.id",
"path" : "Slot.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Slot.meta",
"path" : "Slot.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Slot.implicitRules",
"path" : "Slot.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "Slot.language",
"path" : "Slot.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "Slot.text",
"path" : "Slot.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "Slot.contained",
"path" : "Slot.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Slot.extension",
"path" : "Slot.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Slot.modifierExtension",
"path" : "Slot.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Slot.identifier",
"path" : "Slot.identifier",
"short" : "External Ids for this item",
"definition" : "External Ids for this item.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Slot.identifier",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Identifier"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.identifier"
}]
},
{
"id" : "Slot.serviceCategory",
"path" : "Slot.serviceCategory",
"short" : "A broad categorization of the service that is to be performed during this appointment",
"definition" : "A broad categorization of the service that is to be performed during this appointment.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Slot.serviceCategory",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "service-category"
}],
"strength" : "example",
"valueSet" : "http://hl7.org/fhir/ValueSet/service-category"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.class"
}]
},
{
"id" : "Slot.serviceType",
"path" : "Slot.serviceType",
"short" : "The type of appointments that can be booked into this slot (ideally this would be an identifiable service - which is at a location, rather than the location itself). If provided then this overrides the value provided on the availability resource",
"definition" : "The type of appointments that can be booked into this slot (ideally this would be an identifiable service - which is at a location, rather than the location itself). If provided then this overrides the value provided on the availability resource.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Slot.serviceType",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "service-type"
}],
"strength" : "example",
"valueSet" : "http://hl7.org/fhir/ValueSet/service-type"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.class"
}]
},
{
"id" : "Slot.specialty",
"path" : "Slot.specialty",
"short" : "The specialty of a practitioner that would be required to perform the service requested in this appointment",
"definition" : "The specialty of a practitioner that would be required to perform the service requested in this appointment.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Slot.specialty",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "specialty"
}],
"strength" : "preferred",
"description" : "Additional details about where the content was created (e.g. clinical specialty).",
"valueSet" : "http://hl7.org/fhir/ValueSet/c80-practice-codes"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.class"
}]
},
{
"id" : "Slot.appointmentType",
"path" : "Slot.appointmentType",
"short" : "The style of appointment or patient that may be booked in the slot (not service type)",
"definition" : "The style of appointment or patient that may be booked in the slot (not service type).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Slot.appointmentType",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "appointment-type"
}],
"strength" : "preferred",
"valueSet" : "http://terminology.hl7.org/ValueSet/v2-0276"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.class"
}]
},
{
"id" : "Slot.schedule",
"path" : "Slot.schedule",
"short" : "The schedule resource that this slot defines an interval of status information",
"definition" : "The schedule resource that this slot defines an interval of status information.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Slot.schedule",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Schedule"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Slot.status",
"path" : "Slot.status",
"short" : "busy | free | busy-unavailable | busy-tentative | entered-in-error",
"definition" : "busy | free | busy-unavailable | busy-tentative | entered-in-error.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Slot.status",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SlotStatus"
}],
"strength" : "required",
"description" : "The free/busy status of the slot.",
"valueSet" : "http://hl7.org/fhir/ValueSet/slotstatus|4.0.1"
},
"mapping" : [{
"identity" : "ical",
"map" : "FREEBUSY;FBTYPE=(freeBusyType):19980314T233000Z/19980315T003000Z If the freeBusyType is BUSY, then this value can be excluded"
}]
},
{
"id" : "Slot.start",
"path" : "Slot.start",
"short" : "Date/Time that the slot is to begin",
"definition" : "Date/Time that the slot is to begin.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Slot.start",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "instant"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.planned"
},
{
"identity" : "ical",
"map" : "FREEBUSY;FBTYPE=FREE:(start)/19980315T003000Z If the freeBusyType is BUSY, then this value can be excluded"
}]
},
{
"id" : "Slot.end",
"path" : "Slot.end",
"short" : "Date/Time that the slot is to conclude",
"definition" : "Date/Time that the slot is to conclude.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Slot.end",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "instant"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.planned"
},
{
"identity" : "ical",
"map" : "FREEBUSY:19980314T233000Z/(end) If the freeBusyType is BUSY, then this value can be excluded (as shown)"
}]
},
{
"id" : "Slot.overbooked",
"path" : "Slot.overbooked",
"short" : "This slot has already been overbooked, appointments are unlikely to be accepted for this time",
"definition" : "This slot has already been overbooked, appointments are unlikely to be accepted for this time.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Slot.overbooked",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"meaningWhenMissing" : "If overbooked is missing, systems may assume that there are still appointments available",
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Slot.comment",
"path" : "Slot.comment",
"short" : "Comments on the slot to describe any extended information. Such as custom constraints on the slot",
"definition" : "Comments on the slot to describe any extended information. Such as custom constraints on the slot.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Slot.comment",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
}]
},
"differential" : {
"element" : [{
"id" : "Slot",
"path" : "Slot",
"short" : "A slot of time on a schedule that may be available for booking appointments",
"definition" : "A slot of time on a schedule that may be available for booking appointments.",
"min" : 0,
"max" : "*",
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "ical",
"map" : "(refer to the Availability resource for the header mapping details)"
}]
},
{
"id" : "Slot.identifier",
"path" : "Slot.identifier",
"short" : "External Ids for this item",
"definition" : "External Ids for this item.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Identifier"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.identifier"
}]
},
{
"id" : "Slot.serviceCategory",
"path" : "Slot.serviceCategory",
"short" : "A broad categorization of the service that is to be performed during this appointment",
"definition" : "A broad categorization of the service that is to be performed during this appointment.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "service-category"
}],
"strength" : "example",
"valueSet" : "http://hl7.org/fhir/ValueSet/service-category"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.class"
}]
},
{
"id" : "Slot.serviceType",
"path" : "Slot.serviceType",
"short" : "The type of appointments that can be booked into this slot (ideally this would be an identifiable service - which is at a location, rather than the location itself). If provided then this overrides the value provided on the availability resource",
"definition" : "The type of appointments that can be booked into this slot (ideally this would be an identifiable service - which is at a location, rather than the location itself). If provided then this overrides the value provided on the availability resource.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "service-type"
}],
"strength" : "example",
"valueSet" : "http://hl7.org/fhir/ValueSet/service-type"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.class"
}]
},
{
"id" : "Slot.specialty",
"path" : "Slot.specialty",
"short" : "The specialty of a practitioner that would be required to perform the service requested in this appointment",
"definition" : "The specialty of a practitioner that would be required to perform the service requested in this appointment.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "specialty"
}],
"strength" : "preferred",
"description" : "Additional details about where the content was created (e.g. clinical specialty).",
"valueSet" : "http://hl7.org/fhir/ValueSet/c80-practice-codes"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.class"
}]
},
{
"id" : "Slot.appointmentType",
"path" : "Slot.appointmentType",
"short" : "The style of appointment or patient that may be booked in the slot (not service type)",
"definition" : "The style of appointment or patient that may be booked in the slot (not service type).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "appointment-type"
}],
"strength" : "preferred",
"valueSet" : "http://terminology.hl7.org/ValueSet/v2-0276"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.class"
}]
},
{
"id" : "Slot.schedule",
"path" : "Slot.schedule",
"short" : "The schedule resource that this slot defines an interval of status information",
"definition" : "The schedule resource that this slot defines an interval of status information.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Schedule"]
}],
"isSummary" : true
},
{
"id" : "Slot.status",
"path" : "Slot.status",
"short" : "busy | free | busy-unavailable | busy-tentative | entered-in-error",
"definition" : "busy | free | busy-unavailable | busy-tentative | entered-in-error.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SlotStatus"
}],
"strength" : "required",
"description" : "The free/busy status of the slot.",
"valueSet" : "http://hl7.org/fhir/ValueSet/slotstatus|4.0.1"
},
"mapping" : [{
"identity" : "ical",
"map" : "FREEBUSY;FBTYPE=(freeBusyType):19980314T233000Z/19980315T003000Z If the freeBusyType is BUSY, then this value can be excluded"
}]
},
{
"id" : "Slot.start",
"path" : "Slot.start",
"short" : "Date/Time that the slot is to begin",
"definition" : "Date/Time that the slot is to begin.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "instant"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.planned"
},
{
"identity" : "ical",
"map" : "FREEBUSY;FBTYPE=FREE:(start)/19980315T003000Z If the freeBusyType is BUSY, then this value can be excluded"
}]
},
{
"id" : "Slot.end",
"path" : "Slot.end",
"short" : "Date/Time that the slot is to conclude",
"definition" : "Date/Time that the slot is to conclude.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "instant"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.planned"
},
{
"identity" : "ical",
"map" : "FREEBUSY:19980314T233000Z/(end) If the freeBusyType is BUSY, then this value can be excluded (as shown)"
}]
},
{
"id" : "Slot.overbooked",
"path" : "Slot.overbooked",
"short" : "This slot has already been overbooked, appointments are unlikely to be accepted for this time",
"definition" : "This slot has already been overbooked, appointments are unlikely to be accepted for this time.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "boolean"
}],
"meaningWhenMissing" : "If overbooked is missing, systems may assume that there are still appointments available"
},
{
"id" : "Slot.comment",
"path" : "Slot.comment",
"short" : "Comments on the slot to describe any extended information. Such as custom constraints on the slot",
"definition" : "Comments on the slot to describe any extended information. Such as custom constraints on the slot.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}]
}]
}
}
},
{
"fullUrl" : "http://hl7.org/fhir/StructureDefinition/Specimen",
"resource" : {
"resourceType" : "StructureDefinition",
"id" : "Specimen",
"meta" : {
"lastUpdated" : "2019-11-01T09:29:23.356+11:00"
},
"text" : {
"status" : "generated",
"div" : "Name Flags Card. Type Description & Constraints Specimen TU DomainResource Sample for analysis
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension identifier Σ 0..* Identifier External Identifier
accessionIdentifier Σ 0..1 Identifier Identifier assigned by the lab status ?!Σ 0..1 code available | unavailable | unsatisfactory | entered-in-error
SpecimenStatus (Required) type Σ 0..1 CodeableConcept Kind of material that forms the specimen
v2 Specimen Type (Example) subject Σ 0..1 Reference(Patient | Group | Device | 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 or a device receivedTime Σ 0..1 dateTime The time when specimen was received for processing parent 0..* Reference(Specimen) Specimen from which this specimen originated
request 0..* Reference(ServiceRequest) Why the specimen was collected
collection 0..1 BackboneElement Collection details collector Σ 0..1 Reference(Practitioner | PractitionerRole) Who collected the specimen collected[x] Σ 0..1 Collection time collectedDateTime dateTime collectedPeriod Period duration Σ 0..1 Duration How long it took to collect specimen quantity 0..1 SimpleQuantity The quantity of specimen collected method 0..1 CodeableConcept Technique used to perform collection
FHIR Specimen Collection Method (Example) bodySite 0..1 CodeableConcept Anatomical collection site
SNOMED CT Body Structures (Example) fastingStatus[x] Σ 0..1 Whether or how long patient abstained from food and/or drink
v2 Relevant Clincial Information (Extensible) fastingStatusCodeableConcept CodeableConcept fastingStatusDuration Duration processing 0..* BackboneElement Processing and processing step details
description 0..1 string Textual description of procedure procedure 0..1 CodeableConcept Indicates the treatment step applied to the specimen
Specimen processing procedure (Example) additive 0..* Reference(Substance) Material used in the processing step
time[x] 0..1 Date and time of specimen processing timeDateTime dateTime timePeriod Period container 0..* BackboneElement Direct container of specimen (tube/slide, etc.)
identifier Σ 0..* Identifier Id for the container
description 0..1 string Textual description of the container type 0..1 CodeableConcept Kind of container directly associated with specimen
Specimen container (Example) capacity 0..1 SimpleQuantity Container volume or size specimenQuantity 0..1 SimpleQuantity Quantity of specimen within container additive[x] 0..1 Additive associated with container
v2 Additive (Example) additiveCodeableConcept CodeableConcept additiveReference Reference(Substance) condition Σ 0..* CodeableConcept State of the specimen
v2 Specimen Condition (Extensible)
note 0..* Annotation Comments
Documentation for this format
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Clinical.Diagnostics"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 2
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "patient"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "oo"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/Specimen",
"version" : "4.0.1",
"name" : "Specimen",
"status" : "draft",
"date" : "2019-11-01T09:29:23+11:00",
"publisher" : "Health Level Seven International (Orders and Observations)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/orders/index.cfm"
}]
}],
"description" : "A sample to be used for analysis.",
"fhirVersion" : "4.0.1",
"mapping" : [{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/fivews",
"name" : "FiveWs Pattern Mapping"
},
{
"identity" : "v2",
"uri" : "http://hl7.org/v2",
"name" : "HL7 v2 Mapping"
}],
"kind" : "resource",
"abstract" : false,
"type" : "Specimen",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "Specimen",
"path" : "Specimen",
"short" : "Sample for analysis",
"definition" : "A sample to be used for analysis.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Specimen",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "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",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.`div`.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "rim",
"map" : "Role[classCode=SPEC]"
}]
},
{
"id" : "Specimen.id",
"path" : "Specimen.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Specimen.meta",
"path" : "Specimen.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Specimen.implicitRules",
"path" : "Specimen.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "Specimen.language",
"path" : "Specimen.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "Specimen.text",
"path" : "Specimen.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "Specimen.contained",
"path" : "Specimen.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Specimen.extension",
"path" : "Specimen.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Specimen.modifierExtension",
"path" : "Specimen.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Specimen.identifier",
"path" : "Specimen.identifier",
"short" : "External Identifier",
"definition" : "Id for specimen.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Specimen.identifier",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Identifier"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "v2",
"map" : "SPM-2"
},
{
"identity" : "rim",
"map" : ".id"
}]
},
{
"id" : "Specimen.accessionIdentifier",
"path" : "Specimen.accessionIdentifier",
"short" : "Identifier assigned by the lab",
"definition" : "The identifier assigned by the lab when accessioning specimen(s). This is not necessarily the same as the specimen identifier, depending on local lab procedures.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Specimen.accessionIdentifier",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Identifier"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "v2",
"map" : "SPM-30 (v2.7+)"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=SBJ].act[classCode=ACSN, moodCode=EVN].id"
}]
},
{
"id" : "Specimen.status",
"path" : "Specimen.status",
"short" : "available | unavailable | unsatisfactory | entered-in-error",
"definition" : "The availability of the specimen.",
"comment" : "This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Specimen.status",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SpecimenStatus"
}],
"strength" : "required",
"description" : "Codes providing the status/availability of a specimen.",
"valueSet" : "http://hl7.org/fhir/ValueSet/specimen-status|4.0.1"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.status"
},
{
"identity" : "v2",
"map" : "SPM-20"
},
{
"identity" : "rim",
"map" : "status"
}]
},
{
"id" : "Specimen.type",
"path" : "Specimen.type",
"short" : "Kind of material that forms the specimen",
"definition" : "The kind of material that forms the specimen.",
"comment" : "The type can change the way that a specimen is handled and drives what kind of analyses can properly be performed on the specimen. It is frequently used in diagnostic work flow decision making systems.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Specimen.type",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SpecimenType"
}],
"strength" : "example",
"description" : "The type of the specimen.",
"valueSet" : "http://terminology.hl7.org/ValueSet/v2-0487"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.what[x]"
},
{
"identity" : "v2",
"map" : "SPM-4 and possibly SPM-5"
},
{
"identity" : "rim",
"map" : ".code"
}]
},
{
"id" : "Specimen.subject",
"path" : "Specimen.subject",
"short" : "Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device",
"definition" : "Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device.",
"requirements" : "Must know the subject context.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Specimen.subject",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Group",
"http://hl7.org/fhir/StructureDefinition/Device",
"http://hl7.org/fhir/StructureDefinition/Substance",
"http://hl7.org/fhir/StructureDefinition/Location"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.subject[x]"
},
{
"identity" : "rim",
"map" : ".scoper or .scoper.playsRole"
},
{
"identity" : "w5",
"map" : "FiveWs.subject"
}]
},
{
"id" : "Specimen.receivedTime",
"path" : "Specimen.receivedTime",
"short" : "The time when specimen was received for processing",
"definition" : "Time when specimen was received for processing or testing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Specimen.receivedTime",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.done[x]"
},
{
"identity" : "v2",
"map" : "SPM-18"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=SBJ].act[code=SPCREC, moodCode=EVN].effectiveTime"
}]
},
{
"id" : "Specimen.parent",
"path" : "Specimen.parent",
"short" : "Specimen from which this specimen originated",
"definition" : "Reference to the parent (source) specimen which is used when the specimen was either derived from or a component of another specimen.",
"comment" : "The parent specimen could be the source from which the current specimen is derived by some processing step (e.g. an aliquot or isolate or extracted nucleic acids from clinical samples) or one of many specimens that were combined to create a pooled sample.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Specimen.parent",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Specimen"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".scoper (if parent) .player.scopesRole[classCode=SPEC].player (if child)"
}]
},
{
"id" : "Specimen.request",
"path" : "Specimen.request",
"short" : "Why the specimen was collected",
"definition" : "Details concerning a service request that required a specimen to be collected.",
"comment" : "The request may be explicit or implied such with a ServiceRequest that requires a blood draw.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Specimen.request",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ServiceRequest"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "v2",
"map" : "ORC? OBR-2/3?"
},
{
"identity" : "rim",
"map" : "outboundRelationship[typeCode=FLFS].target"
}]
},
{
"id" : "Specimen.collection",
"path" : "Specimen.collection",
"short" : "Collection details",
"definition" : "Details concerning the specimen collection.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Specimen.collection",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "SPM-14"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=SBJ].act[classCode=SPECCOLLECT, moodCode=EVN]"
}]
},
{
"id" : "Specimen.collection.id",
"path" : "Specimen.collection.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Specimen.collection.extension",
"path" : "Specimen.collection.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Specimen.collection.modifierExtension",
"path" : "Specimen.collection.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Specimen.collection.collector",
"path" : "Specimen.collection.collector",
"short" : "Who collected the specimen",
"definition" : "Person who collected the specimen.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Specimen.collection.collector",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.actor"
},
{
"identity" : "v2",
"map" : "PRT"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=PFM].role"
}]
},
{
"id" : "Specimen.collection.collected[x]",
"path" : "Specimen.collection.collected[x]",
"short" : "Collection time",
"definition" : "Time when specimen was collected from subject - the physiologically relevant time.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Specimen.collection.collected[x]",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
},
{
"code" : "Period"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.init"
},
{
"identity" : "v2",
"map" : "SPM-17"
},
{
"identity" : "rim",
"map" : ".effectiveTime"
}]
},
{
"id" : "Specimen.collection.duration",
"path" : "Specimen.collection.duration",
"short" : "How long it took to collect specimen",
"definition" : "The span of time over which the collection of a specimen occurred.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Specimen.collection.duration",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Duration"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.init"
}]
},
{
"id" : "Specimen.collection.quantity",
"path" : "Specimen.collection.quantity",
"short" : "The quantity of specimen collected",
"definition" : "The quantity of specimen collected; for instance the volume of a blood sample, or the physical measurement of an anatomic pathology sample.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Specimen.collection.quantity",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Quantity",
"profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "SPM-12"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=SBJ].role[classCode=SPEC].player.quantity"
}]
},
{
"id" : "Specimen.collection.method",
"path" : "Specimen.collection.method",
"short" : "Technique used to perform collection",
"definition" : "A coded value specifying the technique that is used to perform the procedure.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Specimen.collection.method",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SpecimenCollectionMethod"
}],
"strength" : "example",
"description" : "The technique that is used to perform the procedure.",
"valueSet" : "http://hl7.org/fhir/ValueSet/specimen-collection-method"
},
"mapping" : [{
"identity" : "v2",
"map" : "SPM-7"
},
{
"identity" : "rim",
"map" : ".methodCode"
}]
},
{
"id" : "Specimen.collection.bodySite",
"path" : "Specimen.collection.bodySite",
"short" : "Anatomical collection site",
"definition" : "Anatomical location from which the specimen was collected (if subject is a patient). This is the target site. This element is not used for environmental specimens.",
"comment" : "If the use case requires BodySite to be handled as a separate resource instead of an inline coded element (e.g. to identify and track separately) then use the standard extension [bodySite](extension-bodysite.html).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Specimen.collection.bodySite",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "BodySite"
}],
"strength" : "example",
"description" : "Codes describing anatomical locations. May include laterality.",
"valueSet" : "http://hl7.org/fhir/ValueSet/body-site"
},
"mapping" : [{
"identity" : "v2",
"map" : "SPM-8 and SPM-9"
},
{
"identity" : "rim",
"map" : ".targetSiteCode"
}]
},
{
"id" : "Specimen.collection.fastingStatus[x]",
"path" : "Specimen.collection.fastingStatus[x]",
"short" : "Whether or how long patient abstained from food and/or drink",
"definition" : "Abstinence or reduction from some or all food, drink, or both, for a period of time prior to sample collection.",
"comment" : "Representing fasting status using this element is preferred to representing it with an observation using a 'pre-coordinated code' such as LOINC 2005-7 (Calcium [Moles/time] in 2 hour Urine --12 hours fasting), or using a component observation ` such as `Observation.component code` = LOINC 49541-6 (Fasting status - Reported).",
"requirements" : "Many diagnostic tests require fasting to facilitate accurate interpretation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Specimen.collection.fastingStatus[x]",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
},
{
"code" : "Duration"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "FastingStatus"
}],
"strength" : "extensible",
"description" : "Codes describing the fasting status of the patient.",
"valueSet" : "http://terminology.hl7.org/ValueSet/v2-0916"
},
"mapping" : [{
"identity" : "v2",
"map" : "OBR-"
}]
},
{
"id" : "Specimen.processing",
"path" : "Specimen.processing",
"short" : "Processing and processing step details",
"definition" : "Details concerning processing and processing steps for the specimen.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Specimen.processing",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".participation[typeCode=SBJ].act[code=SPCTRT, moodCode=EVN]"
}]
},
{
"id" : "Specimen.processing.id",
"path" : "Specimen.processing.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Specimen.processing.extension",
"path" : "Specimen.processing.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Specimen.processing.modifierExtension",
"path" : "Specimen.processing.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Specimen.processing.description",
"path" : "Specimen.processing.description",
"short" : "Textual description of procedure",
"definition" : "Textual description of procedure.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Specimen.processing.description",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".text"
}]
},
{
"id" : "Specimen.processing.procedure",
"path" : "Specimen.processing.procedure",
"short" : "Indicates the treatment step applied to the specimen",
"definition" : "A coded value specifying the procedure used to process the specimen.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Specimen.processing.procedure",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SpecimenProcessingProcedure"
}],
"strength" : "example",
"description" : "Type indicating the technique used to process the specimen.",
"valueSet" : "http://hl7.org/fhir/ValueSet/specimen-processing-procedure"
},
"mapping" : [{
"identity" : "rim",
"map" : ".code"
}]
},
{
"id" : "Specimen.processing.additive",
"path" : "Specimen.processing.additive",
"short" : "Material used in the processing step",
"definition" : "Material used in the processing step.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Specimen.processing.additive",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Substance"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "SPM-6"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=CSM].role[classCode=ADTV].code"
}]
},
{
"id" : "Specimen.processing.time[x]",
"path" : "Specimen.processing.time[x]",
"short" : "Date and time of specimen processing",
"definition" : "A record of the time or period when the specimen processing occurred. For example the time of sample fixation or the period of time the sample was in formalin.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Specimen.processing.time[x]",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
},
{
"code" : "Period"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".effectiveTime"
}]
},
{
"id" : "Specimen.container",
"path" : "Specimen.container",
"short" : "Direct container of specimen (tube/slide, etc.)",
"definition" : "The container holding the specimen. The recursive nature of containers; i.e. blood in tube in tray in rack is not addressed here.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Specimen.container",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".player.scopingRole[classCode=CONT].scoper"
}]
},
{
"id" : "Specimen.container.id",
"path" : "Specimen.container.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Specimen.container.extension",
"path" : "Specimen.container.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Specimen.container.modifierExtension",
"path" : "Specimen.container.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Specimen.container.identifier",
"path" : "Specimen.container.identifier",
"short" : "Id for the container",
"definition" : "Id for container. There may be multiple; a manufacturer's bar code, lab assigned identifier, etc. The container ID may differ from the specimen id in some circumstances.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Specimen.container.identifier",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Identifier"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "v2",
"map" : "SAC-3"
},
{
"identity" : "rim",
"map" : ".id"
}]
},
{
"id" : "Specimen.container.description",
"path" : "Specimen.container.description",
"short" : "Textual description of the container",
"definition" : "Textual description of the container.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Specimen.container.description",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".desc"
}]
},
{
"id" : "Specimen.container.type",
"path" : "Specimen.container.type",
"short" : "Kind of container directly associated with specimen",
"definition" : "The type of container associated with the specimen (e.g. slide, aliquot, etc.).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Specimen.container.type",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SpecimenContainerType"
}],
"strength" : "example",
"description" : "Type of specimen container.",
"valueSet" : "http://hl7.org/fhir/ValueSet/specimen-container-type"
},
"mapping" : [{
"identity" : "v2",
"map" : "SPM-27"
},
{
"identity" : "rim",
"map" : ".code"
}]
},
{
"id" : "Specimen.container.capacity",
"path" : "Specimen.container.capacity",
"short" : "Container volume or size",
"definition" : "The capacity (volume or other measure) the container may contain.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Specimen.container.capacity",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Quantity",
"profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "one of: SAC 16, SAC17 and SAC 20, or SAC 21 and SAC 20"
},
{
"identity" : "rim",
"map" : ".quantity"
}]
},
{
"id" : "Specimen.container.specimenQuantity",
"path" : "Specimen.container.specimenQuantity",
"short" : "Quantity of specimen within container",
"definition" : "The quantity of specimen in the container; may be volume, dimensions, or other appropriate measurements, depending on the specimen type.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Specimen.container.specimenQuantity",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Quantity",
"profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "SAC-23 (value) SAC-24 (units"
},
{
"identity" : "rim",
"map" : ".playedRole[classCode=CONT].quantity"
}]
},
{
"id" : "Specimen.container.additive[x]",
"path" : "Specimen.container.additive[x]",
"short" : "Additive associated with container",
"definition" : "Introduced substance to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Specimen.container.additive[x]",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
},
{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Substance"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SpecimenContainerAdditive"
}],
"strength" : "example",
"description" : "Substance added to specimen container.",
"valueSet" : "http://terminology.hl7.org/ValueSet/v2-0371"
},
"mapping" : [{
"identity" : "v2",
"map" : "SAC-27"
},
{
"identity" : "rim",
"map" : ".scopesRole[classCode=ADTV].player"
}]
},
{
"id" : "Specimen.condition",
"path" : "Specimen.condition",
"short" : "State of the specimen",
"definition" : "A mode or state of being that describes the nature of the specimen.",
"comment" : "Specimen condition is an observation made about the specimen. It's a point-in-time assessment. It can be used to assess its quality or appropriateness for a specific test.",
"requirements" : "The specimen condition can be used to assess its quality or appropriateness for a specific test.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Specimen.condition",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SpecimenCondition"
}],
"strength" : "extensible",
"description" : "Codes describing the state of the specimen.",
"valueSet" : "http://terminology.hl7.org/ValueSet/v2-0493"
},
"mapping" : [{
"identity" : "v2",
"map" : "SPM-24"
}]
},
{
"id" : "Specimen.note",
"path" : "Specimen.note",
"short" : "Comments",
"definition" : "To communicate any details or issues about the specimen or during the specimen collection. (for example: broken vial, sent with patient, frozen).",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Specimen.note",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Annotation"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "OBX"
},
{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"annotation\"].value"
}]
}]
},
"differential" : {
"element" : [{
"id" : "Specimen",
"path" : "Specimen",
"short" : "Sample for analysis",
"definition" : "A sample to be used for analysis.",
"min" : 0,
"max" : "*",
"mapping" : [{
"identity" : "rim",
"map" : "Role[classCode=SPEC]"
}]
},
{
"id" : "Specimen.identifier",
"path" : "Specimen.identifier",
"short" : "External Identifier",
"definition" : "Id for specimen.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Identifier"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "v2",
"map" : "SPM-2"
},
{
"identity" : "rim",
"map" : ".id"
}]
},
{
"id" : "Specimen.accessionIdentifier",
"path" : "Specimen.accessionIdentifier",
"short" : "Identifier assigned by the lab",
"definition" : "The identifier assigned by the lab when accessioning specimen(s). This is not necessarily the same as the specimen identifier, depending on local lab procedures.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Identifier"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "v2",
"map" : "SPM-30 (v2.7+)"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=SBJ].act[classCode=ACSN, moodCode=EVN].id"
}]
},
{
"id" : "Specimen.status",
"path" : "Specimen.status",
"short" : "available | unavailable | unsatisfactory | entered-in-error",
"definition" : "The availability of the specimen.",
"comment" : "This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isModifier" : true,
"isModifierReason" : "This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SpecimenStatus"
}],
"strength" : "required",
"description" : "Codes providing the status/availability of a specimen.",
"valueSet" : "http://hl7.org/fhir/ValueSet/specimen-status|4.0.1"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.status"
},
{
"identity" : "v2",
"map" : "SPM-20"
},
{
"identity" : "rim",
"map" : "status"
}]
},
{
"id" : "Specimen.type",
"path" : "Specimen.type",
"short" : "Kind of material that forms the specimen",
"definition" : "The kind of material that forms the specimen.",
"comment" : "The type can change the way that a specimen is handled and drives what kind of analyses can properly be performed on the specimen. It is frequently used in diagnostic work flow decision making systems.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SpecimenType"
}],
"strength" : "example",
"description" : "The type of the specimen.",
"valueSet" : "http://terminology.hl7.org/ValueSet/v2-0487"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.what[x]"
},
{
"identity" : "v2",
"map" : "SPM-4 and possibly SPM-5"
},
{
"identity" : "rim",
"map" : ".code"
}]
},
{
"id" : "Specimen.subject",
"path" : "Specimen.subject",
"short" : "Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device",
"definition" : "Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device.",
"requirements" : "Must know the subject context.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Group",
"http://hl7.org/fhir/StructureDefinition/Device",
"http://hl7.org/fhir/StructureDefinition/Substance",
"http://hl7.org/fhir/StructureDefinition/Location"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.subject[x]"
},
{
"identity" : "rim",
"map" : ".scoper or .scoper.playsRole"
},
{
"identity" : "w5",
"map" : "FiveWs.subject"
}]
},
{
"id" : "Specimen.receivedTime",
"path" : "Specimen.receivedTime",
"short" : "The time when specimen was received for processing",
"definition" : "Time when specimen was received for processing or testing.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "dateTime"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.done[x]"
},
{
"identity" : "v2",
"map" : "SPM-18"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=SBJ].act[code=SPCREC, moodCode=EVN].effectiveTime"
}]
},
{
"id" : "Specimen.parent",
"path" : "Specimen.parent",
"short" : "Specimen from which this specimen originated",
"definition" : "Reference to the parent (source) specimen which is used when the specimen was either derived from or a component of another specimen.",
"comment" : "The parent specimen could be the source from which the current specimen is derived by some processing step (e.g. an aliquot or isolate or extracted nucleic acids from clinical samples) or one of many specimens that were combined to create a pooled sample.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Specimen"]
}],
"mapping" : [{
"identity" : "rim",
"map" : ".scoper (if parent) .player.scopesRole[classCode=SPEC].player (if child)"
}]
},
{
"id" : "Specimen.request",
"path" : "Specimen.request",
"short" : "Why the specimen was collected",
"definition" : "Details concerning a service request that required a specimen to be collected.",
"comment" : "The request may be explicit or implied such with a ServiceRequest that requires a blood draw.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ServiceRequest"]
}],
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "v2",
"map" : "ORC? OBR-2/3?"
},
{
"identity" : "rim",
"map" : "outboundRelationship[typeCode=FLFS].target"
}]
},
{
"id" : "Specimen.collection",
"path" : "Specimen.collection",
"short" : "Collection details",
"definition" : "Details concerning the specimen collection.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "BackboneElement"
}],
"mapping" : [{
"identity" : "v2",
"map" : "SPM-14"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=SBJ].act[classCode=SPECCOLLECT, moodCode=EVN]"
}]
},
{
"id" : "Specimen.collection.collector",
"path" : "Specimen.collection.collector",
"short" : "Who collected the specimen",
"definition" : "Person who collected the specimen.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.actor"
},
{
"identity" : "v2",
"map" : "PRT"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=PFM].role"
}]
},
{
"id" : "Specimen.collection.collected[x]",
"path" : "Specimen.collection.collected[x]",
"short" : "Collection time",
"definition" : "Time when specimen was collected from subject - the physiologically relevant time.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "dateTime"
},
{
"code" : "Period"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.init"
},
{
"identity" : "v2",
"map" : "SPM-17"
},
{
"identity" : "rim",
"map" : ".effectiveTime"
}]
},
{
"id" : "Specimen.collection.duration",
"path" : "Specimen.collection.duration",
"short" : "How long it took to collect specimen",
"definition" : "The span of time over which the collection of a specimen occurred.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Duration"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.init"
}]
},
{
"id" : "Specimen.collection.quantity",
"path" : "Specimen.collection.quantity",
"short" : "The quantity of specimen collected",
"definition" : "The quantity of specimen collected; for instance the volume of a blood sample, or the physical measurement of an anatomic pathology sample.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Quantity",
"profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
}],
"mapping" : [{
"identity" : "v2",
"map" : "SPM-12"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=SBJ].role[classCode=SPEC].player.quantity"
}]
},
{
"id" : "Specimen.collection.method",
"path" : "Specimen.collection.method",
"short" : "Technique used to perform collection",
"definition" : "A coded value specifying the technique that is used to perform the procedure.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SpecimenCollectionMethod"
}],
"strength" : "example",
"description" : "The technique that is used to perform the procedure.",
"valueSet" : "http://hl7.org/fhir/ValueSet/specimen-collection-method"
},
"mapping" : [{
"identity" : "v2",
"map" : "SPM-7"
},
{
"identity" : "rim",
"map" : ".methodCode"
}]
},
{
"id" : "Specimen.collection.bodySite",
"path" : "Specimen.collection.bodySite",
"short" : "Anatomical collection site",
"definition" : "Anatomical location from which the specimen was collected (if subject is a patient). This is the target site. This element is not used for environmental specimens.",
"comment" : "If the use case requires BodySite to be handled as a separate resource instead of an inline coded element (e.g. to identify and track separately) then use the standard extension [bodySite](extension-bodysite.html).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "BodySite"
}],
"strength" : "example",
"description" : "Codes describing anatomical locations. May include laterality.",
"valueSet" : "http://hl7.org/fhir/ValueSet/body-site"
},
"mapping" : [{
"identity" : "v2",
"map" : "SPM-8 and SPM-9"
},
{
"identity" : "rim",
"map" : ".targetSiteCode"
}]
},
{
"id" : "Specimen.collection.fastingStatus[x]",
"path" : "Specimen.collection.fastingStatus[x]",
"short" : "Whether or how long patient abstained from food and/or drink",
"definition" : "Abstinence or reduction from some or all food, drink, or both, for a period of time prior to sample collection.",
"comment" : "Representing fasting status using this element is preferred to representing it with an observation using a 'pre-coordinated code' such as LOINC 2005-7 (Calcium [Moles/time] in 2 hour Urine --12 hours fasting), or using a component observation ` such as `Observation.component code` = LOINC 49541-6 (Fasting status - Reported).",
"requirements" : "Many diagnostic tests require fasting to facilitate accurate interpretation.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
},
{
"code" : "Duration"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "FastingStatus"
}],
"strength" : "extensible",
"description" : "Codes describing the fasting status of the patient.",
"valueSet" : "http://terminology.hl7.org/ValueSet/v2-0916"
},
"mapping" : [{
"identity" : "v2",
"map" : "OBR-"
}]
},
{
"id" : "Specimen.processing",
"path" : "Specimen.processing",
"short" : "Processing and processing step details",
"definition" : "Details concerning processing and processing steps for the specimen.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"mapping" : [{
"identity" : "rim",
"map" : ".participation[typeCode=SBJ].act[code=SPCTRT, moodCode=EVN]"
}]
},
{
"id" : "Specimen.processing.description",
"path" : "Specimen.processing.description",
"short" : "Textual description of procedure",
"definition" : "Textual description of procedure.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"mapping" : [{
"identity" : "rim",
"map" : ".text"
}]
},
{
"id" : "Specimen.processing.procedure",
"path" : "Specimen.processing.procedure",
"short" : "Indicates the treatment step applied to the specimen",
"definition" : "A coded value specifying the procedure used to process the specimen.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SpecimenProcessingProcedure"
}],
"strength" : "example",
"description" : "Type indicating the technique used to process the specimen.",
"valueSet" : "http://hl7.org/fhir/ValueSet/specimen-processing-procedure"
},
"mapping" : [{
"identity" : "rim",
"map" : ".code"
}]
},
{
"id" : "Specimen.processing.additive",
"path" : "Specimen.processing.additive",
"short" : "Material used in the processing step",
"definition" : "Material used in the processing step.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Substance"]
}],
"mapping" : [{
"identity" : "v2",
"map" : "SPM-6"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=CSM].role[classCode=ADTV].code"
}]
},
{
"id" : "Specimen.processing.time[x]",
"path" : "Specimen.processing.time[x]",
"short" : "Date and time of specimen processing",
"definition" : "A record of the time or period when the specimen processing occurred. For example the time of sample fixation or the period of time the sample was in formalin.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "dateTime"
},
{
"code" : "Period"
}],
"mapping" : [{
"identity" : "rim",
"map" : ".effectiveTime"
}]
},
{
"id" : "Specimen.container",
"path" : "Specimen.container",
"short" : "Direct container of specimen (tube/slide, etc.)",
"definition" : "The container holding the specimen. The recursive nature of containers; i.e. blood in tube in tray in rack is not addressed here.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"mapping" : [{
"identity" : "rim",
"map" : ".player.scopingRole[classCode=CONT].scoper"
}]
},
{
"id" : "Specimen.container.identifier",
"path" : "Specimen.container.identifier",
"short" : "Id for the container",
"definition" : "Id for container. There may be multiple; a manufacturer's bar code, lab assigned identifier, etc. The container ID may differ from the specimen id in some circumstances.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Identifier"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "v2",
"map" : "SAC-3"
},
{
"identity" : "rim",
"map" : ".id"
}]
},
{
"id" : "Specimen.container.description",
"path" : "Specimen.container.description",
"short" : "Textual description of the container",
"definition" : "Textual description of the container.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"mapping" : [{
"identity" : "rim",
"map" : ".desc"
}]
},
{
"id" : "Specimen.container.type",
"path" : "Specimen.container.type",
"short" : "Kind of container directly associated with specimen",
"definition" : "The type of container associated with the specimen (e.g. slide, aliquot, etc.).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SpecimenContainerType"
}],
"strength" : "example",
"description" : "Type of specimen container.",
"valueSet" : "http://hl7.org/fhir/ValueSet/specimen-container-type"
},
"mapping" : [{
"identity" : "v2",
"map" : "SPM-27"
},
{
"identity" : "rim",
"map" : ".code"
}]
},
{
"id" : "Specimen.container.capacity",
"path" : "Specimen.container.capacity",
"short" : "Container volume or size",
"definition" : "The capacity (volume or other measure) the container may contain.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Quantity",
"profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
}],
"mapping" : [{
"identity" : "v2",
"map" : "one of: SAC 16, SAC17 and SAC 20, or SAC 21 and SAC 20"
},
{
"identity" : "rim",
"map" : ".quantity"
}]
},
{
"id" : "Specimen.container.specimenQuantity",
"path" : "Specimen.container.specimenQuantity",
"short" : "Quantity of specimen within container",
"definition" : "The quantity of specimen in the container; may be volume, dimensions, or other appropriate measurements, depending on the specimen type.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Quantity",
"profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
}],
"mapping" : [{
"identity" : "v2",
"map" : "SAC-23 (value) SAC-24 (units"
},
{
"identity" : "rim",
"map" : ".playedRole[classCode=CONT].quantity"
}]
},
{
"id" : "Specimen.container.additive[x]",
"path" : "Specimen.container.additive[x]",
"short" : "Additive associated with container",
"definition" : "Introduced substance to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
},
{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Substance"]
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SpecimenContainerAdditive"
}],
"strength" : "example",
"description" : "Substance added to specimen container.",
"valueSet" : "http://terminology.hl7.org/ValueSet/v2-0371"
},
"mapping" : [{
"identity" : "v2",
"map" : "SAC-27"
},
{
"identity" : "rim",
"map" : ".scopesRole[classCode=ADTV].player"
}]
},
{
"id" : "Specimen.condition",
"path" : "Specimen.condition",
"short" : "State of the specimen",
"definition" : "A mode or state of being that describes the nature of the specimen.",
"comment" : "Specimen condition is an observation made about the specimen. It's a point-in-time assessment. It can be used to assess its quality or appropriateness for a specific test.",
"requirements" : "The specimen condition can be used to assess its quality or appropriateness for a specific test.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SpecimenCondition"
}],
"strength" : "extensible",
"description" : "Codes describing the state of the specimen.",
"valueSet" : "http://terminology.hl7.org/ValueSet/v2-0493"
},
"mapping" : [{
"identity" : "v2",
"map" : "SPM-24"
}]
},
{
"id" : "Specimen.note",
"path" : "Specimen.note",
"short" : "Comments",
"definition" : "To communicate any details or issues about the specimen or during the specimen collection. (for example: broken vial, sent with patient, frozen).",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Annotation"
}],
"mapping" : [{
"identity" : "v2",
"map" : "OBX"
},
{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"annotation\"].value"
}]
}]
}
}
},
{
"fullUrl" : "http://hl7.org/fhir/StructureDefinition/SpecimenDefinition",
"resource" : {
"resourceType" : "StructureDefinition",
"id" : "SpecimenDefinition",
"meta" : {
"lastUpdated" : "2019-11-01T09:29:23.356+11:00"
},
"text" : {
"status" : "generated",
"div" : "Name Flags Card. Type Description & Constraints SpecimenDefinition TU DomainResource Kind of specimen
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension identifier Σ 0..1 Identifier Business identifier of a kind of specimen typeCollected Σ 0..1 CodeableConcept Kind of material to collect
v2 Specimen Type (Example) patientPreparation Σ 0..* CodeableConcept Patient preparation for collection
Patient preparation prior specimen collection (Example)
timeAspect Σ 0..1 string Time aspect for collection collection Σ 0..* CodeableConcept Specimen collection procedure
Specimen collection methods (Example)
typeTested 0..* BackboneElement Specimen in container intended for testing by lab
isDerived 0..1 boolean Primary or secondary specimen type 0..1 CodeableConcept Type of intended specimen
v2 Specimen Type (Example) preference 1..1 code preferred | alternate
SpecimenContainedPreference (Required) container 0..1 BackboneElement The specimen's container material 0..1 CodeableConcept Container material
Types of material for specimen containers (Example) type 0..1 CodeableConcept Kind of container associated with the kind of specimen
Specimen Container Type (Example) cap 0..1 CodeableConcept Color of container cap
ContainerCap (Example) description 0..1 string Container description capacity 0..1 SimpleQuantity Container capacity minimumVolume[x] 0..1 Minimum volume minimumVolumeQuantity SimpleQuantity minimumVolumeString string additive 0..* BackboneElement Additive associated with container
additive[x] 1..1 Additive associated with container
v2 Additive (Example) additiveCodeableConcept CodeableConcept additiveReference Reference(Substance) preparation 0..1 string Specimen container preparation requirement 0..1 string Specimen requirements retentionTime 0..1 Duration Specimen retention time rejectionCriterion 0..* CodeableConcept Rejection criterion
RejectionCriterion (Example)
handling 0..* BackboneElement Specimen handling before testing
temperatureQualifier 0..1 CodeableConcept Temperature qualifier
HandlingConditionSet (Example) temperatureRange 0..1 Range Temperature range maxDuration 0..1 Duration Maximum preservation time instruction 0..1 string Preservation instruction
Documentation for this format
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Specialized.Definitional Artifacts"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 0
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "anonymous"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "oo"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/SpecimenDefinition",
"version" : "4.0.1",
"name" : "SpecimenDefinition",
"status" : "draft",
"date" : "2019-11-01T09:29:23+11:00",
"publisher" : "Health Level Seven International (Orders and Observations)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/orders/index.cfm"
}]
}],
"description" : "A kind of specimen with associated set of requirements.",
"fhirVersion" : "4.0.1",
"mapping" : [{
"identity" : "v2",
"uri" : "http://hl7.org/v2",
"name" : "HL7 v2 Mapping"
},
{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
}],
"kind" : "resource",
"abstract" : false,
"type" : "SpecimenDefinition",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "SpecimenDefinition",
"path" : "SpecimenDefinition",
"short" : "Kind of specimen",
"definition" : "A kind of specimen with associated set of requirements.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SpecimenDefinition",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "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",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.`div`.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "v2",
"map" : "OM4"
},
{
"identity" : "rim",
"map" : "Role[classCode=SPEC]"
}]
},
{
"id" : "SpecimenDefinition.id",
"path" : "SpecimenDefinition.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SpecimenDefinition.meta",
"path" : "SpecimenDefinition.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SpecimenDefinition.implicitRules",
"path" : "SpecimenDefinition.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "SpecimenDefinition.language",
"path" : "SpecimenDefinition.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "SpecimenDefinition.text",
"path" : "SpecimenDefinition.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "SpecimenDefinition.contained",
"path" : "SpecimenDefinition.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "SpecimenDefinition.extension",
"path" : "SpecimenDefinition.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "SpecimenDefinition.modifierExtension",
"path" : "SpecimenDefinition.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "SpecimenDefinition.identifier",
"path" : "SpecimenDefinition.identifier",
"short" : "Business identifier of a kind of specimen",
"definition" : "A business identifier associated with the kind of specimen.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SpecimenDefinition.identifier",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Identifier"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SpecimenDefinition.typeCollected",
"path" : "SpecimenDefinition.typeCollected",
"short" : "Kind of material to collect",
"definition" : "The kind of material to be collected.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SpecimenDefinition.typeCollected",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "CollectedSpecimenType"
}],
"strength" : "example",
"description" : "The type of the specimen to be collected.",
"valueSet" : "http://terminology.hl7.org/ValueSet/v2-0487"
},
"mapping" : [{
"identity" : "v2",
"map" : "OM4-6"
}]
},
{
"id" : "SpecimenDefinition.patientPreparation",
"path" : "SpecimenDefinition.patientPreparation",
"short" : "Patient preparation for collection",
"definition" : "Preparation of the patient for specimen collection.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SpecimenDefinition.patientPreparation",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "PreparePatient"
}],
"strength" : "example",
"description" : "Checks on the patient prior specimen collection.",
"valueSet" : "http://hl7.org/fhir/ValueSet/prepare-patient-prior-specimen-collection"
},
"mapping" : [{
"identity" : "v2",
"map" : "OM1-37"
}]
},
{
"id" : "SpecimenDefinition.timeAspect",
"path" : "SpecimenDefinition.timeAspect",
"short" : "Time aspect for collection",
"definition" : "Time aspect of specimen collection (duration or offset).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SpecimenDefinition.timeAspect",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"example" : [{
"label" : "General",
"valueString" : "24 hour, 20' post charge"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "v2",
"map" : "OM1-43, OM1-44"
}]
},
{
"id" : "SpecimenDefinition.collection",
"path" : "SpecimenDefinition.collection",
"short" : "Specimen collection procedure",
"definition" : "The action to be performed for collecting the specimen.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SpecimenDefinition.collection",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SpecimenCollection"
}],
"strength" : "example",
"description" : "The action to collect a type of specimen.",
"valueSet" : "http://hl7.org/fhir/ValueSet/specimen-collection"
}
},
{
"id" : "SpecimenDefinition.typeTested",
"path" : "SpecimenDefinition.typeTested",
"short" : "Specimen in container intended for testing by lab",
"definition" : "Specimen conditioned in a container as expected by the testing laboratory.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SpecimenDefinition.typeTested",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "SpecimenDefinition.typeTested.id",
"path" : "SpecimenDefinition.typeTested.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "SpecimenDefinition.typeTested.extension",
"path" : "SpecimenDefinition.typeTested.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "SpecimenDefinition.typeTested.modifierExtension",
"path" : "SpecimenDefinition.typeTested.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "SpecimenDefinition.typeTested.isDerived",
"path" : "SpecimenDefinition.typeTested.isDerived",
"short" : "Primary or secondary specimen",
"definition" : "Primary of secondary specimen.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SpecimenDefinition.typeTested.isDerived",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"example" : [{
"label" : "General",
"valueBoolean" : false
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "OM4-2"
}]
},
{
"id" : "SpecimenDefinition.typeTested.type",
"path" : "SpecimenDefinition.typeTested.type",
"short" : "Type of intended specimen",
"definition" : "The kind of specimen conditioned for testing expected by lab.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SpecimenDefinition.typeTested.type",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "IntendedSpecimenType"
}],
"strength" : "example",
"description" : "The type of specimen conditioned in a container for lab testing.",
"valueSet" : "http://terminology.hl7.org/ValueSet/v2-0487"
}
},
{
"id" : "SpecimenDefinition.typeTested.preference",
"path" : "SpecimenDefinition.typeTested.preference",
"short" : "preferred | alternate",
"definition" : "The preference for this type of conditioned specimen.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "SpecimenDefinition.typeTested.preference",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"example" : [{
"label" : "General",
"valueCode" : "preferred, alternate"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SpecimenContainedPreference"
}],
"strength" : "required",
"description" : "Degree of preference of a type of conditioned specimen.",
"valueSet" : "http://hl7.org/fhir/ValueSet/specimen-contained-preference|4.0.1"
},
"mapping" : [{
"identity" : "v2",
"map" : "OM4-16"
}]
},
{
"id" : "SpecimenDefinition.typeTested.container",
"path" : "SpecimenDefinition.typeTested.container",
"short" : "The specimen's container",
"definition" : "The specimen's container.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SpecimenDefinition.typeTested.container",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "SpecimenDefinition.typeTested.container.id",
"path" : "SpecimenDefinition.typeTested.container.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "SpecimenDefinition.typeTested.container.extension",
"path" : "SpecimenDefinition.typeTested.container.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "SpecimenDefinition.typeTested.container.modifierExtension",
"path" : "SpecimenDefinition.typeTested.container.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "SpecimenDefinition.typeTested.container.material",
"path" : "SpecimenDefinition.typeTested.container.material",
"short" : "Container material",
"definition" : "The type of material of the container.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SpecimenDefinition.typeTested.container.material",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ContainerMaterial"
}],
"strength" : "example",
"description" : "Types of material for specimen containers.",
"valueSet" : "http://hl7.org/fhir/ValueSet/container-material"
}
},
{
"id" : "SpecimenDefinition.typeTested.container.type",
"path" : "SpecimenDefinition.typeTested.container.type",
"short" : "Kind of container associated with the kind of specimen",
"definition" : "The type of container used to contain this kind of specimen.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SpecimenDefinition.typeTested.container.type",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ContainerType"
}],
"strength" : "example",
"description" : "Type of specimen container.",
"valueSet" : "http://hl7.org/fhir/ValueSet/specimen-container-type"
}
},
{
"id" : "SpecimenDefinition.typeTested.container.cap",
"path" : "SpecimenDefinition.typeTested.container.cap",
"short" : "Color of container cap",
"definition" : "Color of container cap.",
"requirements" : "From ISO 6710-2017 Table F.1 Recommended colour codes.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SpecimenDefinition.typeTested.container.cap",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ContainerCap"
}],
"strength" : "example",
"description" : "Color of the container cap.",
"valueSet" : "http://hl7.org/fhir/ValueSet/container-cap"
}
},
{
"id" : "SpecimenDefinition.typeTested.container.description",
"path" : "SpecimenDefinition.typeTested.container.description",
"short" : "Container description",
"definition" : "The textual description of the kind of container.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SpecimenDefinition.typeTested.container.description",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"example" : [{
"label" : "General",
"valueString" : "Blue top tube with citrate"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "OM4-3"
}]
},
{
"id" : "SpecimenDefinition.typeTested.container.capacity",
"path" : "SpecimenDefinition.typeTested.container.capacity",
"short" : "Container capacity",
"definition" : "The capacity (volume or other measure) of this kind of container.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SpecimenDefinition.typeTested.container.capacity",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Quantity",
"profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "OM4-4, OM4-5"
}]
},
{
"id" : "SpecimenDefinition.typeTested.container.minimumVolume[x]",
"path" : "SpecimenDefinition.typeTested.container.minimumVolume[x]",
"short" : "Minimum volume",
"definition" : "The minimum volume to be conditioned in the container.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SpecimenDefinition.typeTested.container.minimumVolume[x]",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Quantity",
"profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
},
{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "OM4-11"
}]
},
{
"id" : "SpecimenDefinition.typeTested.container.additive",
"path" : "SpecimenDefinition.typeTested.container.additive",
"short" : "Additive associated with container",
"definition" : "Substance introduced in the kind of container to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SpecimenDefinition.typeTested.container.additive",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "OM4-7"
}]
},
{
"id" : "SpecimenDefinition.typeTested.container.additive.id",
"path" : "SpecimenDefinition.typeTested.container.additive.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "SpecimenDefinition.typeTested.container.additive.extension",
"path" : "SpecimenDefinition.typeTested.container.additive.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "SpecimenDefinition.typeTested.container.additive.modifierExtension",
"path" : "SpecimenDefinition.typeTested.container.additive.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "SpecimenDefinition.typeTested.container.additive.additive[x]",
"path" : "SpecimenDefinition.typeTested.container.additive.additive[x]",
"short" : "Additive associated with container",
"definition" : "Substance introduced in the kind of container to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "SpecimenDefinition.typeTested.container.additive.additive[x]",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
},
{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Substance"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ContainerAdditive"
}],
"strength" : "example",
"description" : "Substance added to specimen container.",
"valueSet" : "http://terminology.hl7.org/ValueSet/v2-0371"
},
"mapping" : [{
"identity" : "v2",
"map" : "OM4-7"
}]
},
{
"id" : "SpecimenDefinition.typeTested.container.preparation",
"path" : "SpecimenDefinition.typeTested.container.preparation",
"short" : "Specimen container preparation",
"definition" : "Special processing that should be applied to the container for this kind of specimen.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SpecimenDefinition.typeTested.container.preparation",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "OM4-8"
}]
},
{
"id" : "SpecimenDefinition.typeTested.requirement",
"path" : "SpecimenDefinition.typeTested.requirement",
"short" : "Specimen requirements",
"definition" : "Requirements for delivery and special handling of this kind of conditioned specimen.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SpecimenDefinition.typeTested.requirement",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "OM4-12"
}]
},
{
"id" : "SpecimenDefinition.typeTested.retentionTime",
"path" : "SpecimenDefinition.typeTested.retentionTime",
"short" : "Specimen retention time",
"definition" : "The usual time that a specimen of this kind is retained after the ordered tests are completed, for the purpose of additional testing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SpecimenDefinition.typeTested.retentionTime",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Duration"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "OM4-14"
}]
},
{
"id" : "SpecimenDefinition.typeTested.rejectionCriterion",
"path" : "SpecimenDefinition.typeTested.rejectionCriterion",
"short" : "Rejection criterion",
"definition" : "Criterion for rejection of the specimen in its container by the laboratory.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SpecimenDefinition.typeTested.rejectionCriterion",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "RejectionCriterion"
}],
"strength" : "example",
"description" : "Criterion for rejection of the specimen by laboratory.",
"valueSet" : "http://hl7.org/fhir/ValueSet/rejection-criteria"
},
"mapping" : [{
"identity" : "v2",
"map" : "OM1-39"
}]
},
{
"id" : "SpecimenDefinition.typeTested.handling",
"path" : "SpecimenDefinition.typeTested.handling",
"short" : "Specimen handling before testing",
"definition" : "Set of instructions for preservation/transport of the specimen at a defined temperature interval, prior the testing process.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SpecimenDefinition.typeTested.handling",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "SpecimenDefinition.typeTested.handling.id",
"path" : "SpecimenDefinition.typeTested.handling.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "SpecimenDefinition.typeTested.handling.extension",
"path" : "SpecimenDefinition.typeTested.handling.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "SpecimenDefinition.typeTested.handling.modifierExtension",
"path" : "SpecimenDefinition.typeTested.handling.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "SpecimenDefinition.typeTested.handling.temperatureQualifier",
"path" : "SpecimenDefinition.typeTested.handling.temperatureQualifier",
"short" : "Temperature qualifier",
"definition" : "It qualifies the interval of temperature, which characterizes an occurrence of handling. Conditions that are not related to temperature may be handled in the instruction element.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SpecimenDefinition.typeTested.handling.temperatureQualifier",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "HandlingConditionSet"
}],
"strength" : "example",
"description" : "Set of handling instructions prior testing of the specimen.",
"valueSet" : "http://hl7.org/fhir/ValueSet/handling-condition"
},
"mapping" : [{
"identity" : "v2",
"map" : "OM4-15"
}]
},
{
"id" : "SpecimenDefinition.typeTested.handling.temperatureRange",
"path" : "SpecimenDefinition.typeTested.handling.temperatureRange",
"short" : "Temperature range",
"definition" : "The temperature interval for this set of handling instructions.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SpecimenDefinition.typeTested.handling.temperatureRange",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Range"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "SpecimenDefinition.typeTested.handling.maxDuration",
"path" : "SpecimenDefinition.typeTested.handling.maxDuration",
"short" : "Maximum preservation time",
"definition" : "The maximum time interval of preservation of the specimen with these conditions.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SpecimenDefinition.typeTested.handling.maxDuration",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Duration"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "SpecimenDefinition.typeTested.handling.instruction",
"path" : "SpecimenDefinition.typeTested.handling.instruction",
"short" : "Preservation instruction",
"definition" : "Additional textual instructions for the preservation or transport of the specimen. For instance, 'Protect from light exposure'.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SpecimenDefinition.typeTested.handling.instruction",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"example" : [{
"label" : "General",
"valueString" : "freeze within 4 hours"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
}]
},
"differential" : {
"element" : [{
"id" : "SpecimenDefinition",
"path" : "SpecimenDefinition",
"short" : "Kind of specimen",
"definition" : "A kind of specimen with associated set of requirements.",
"min" : 0,
"max" : "*",
"mapping" : [{
"identity" : "v2",
"map" : "OM4"
},
{
"identity" : "rim",
"map" : "Role[classCode=SPEC]"
}]
},
{
"id" : "SpecimenDefinition.identifier",
"path" : "SpecimenDefinition.identifier",
"short" : "Business identifier of a kind of specimen",
"definition" : "A business identifier associated with the kind of specimen.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Identifier"
}],
"isSummary" : true
},
{
"id" : "SpecimenDefinition.typeCollected",
"path" : "SpecimenDefinition.typeCollected",
"short" : "Kind of material to collect",
"definition" : "The kind of material to be collected.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "CollectedSpecimenType"
}],
"strength" : "example",
"description" : "The type of the specimen to be collected.",
"valueSet" : "http://terminology.hl7.org/ValueSet/v2-0487"
},
"mapping" : [{
"identity" : "v2",
"map" : "OM4-6"
}]
},
{
"id" : "SpecimenDefinition.patientPreparation",
"path" : "SpecimenDefinition.patientPreparation",
"short" : "Patient preparation for collection",
"definition" : "Preparation of the patient for specimen collection.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "PreparePatient"
}],
"strength" : "example",
"description" : "Checks on the patient prior specimen collection.",
"valueSet" : "http://hl7.org/fhir/ValueSet/prepare-patient-prior-specimen-collection"
},
"mapping" : [{
"identity" : "v2",
"map" : "OM1-37"
}]
},
{
"id" : "SpecimenDefinition.timeAspect",
"path" : "SpecimenDefinition.timeAspect",
"short" : "Time aspect for collection",
"definition" : "Time aspect of specimen collection (duration or offset).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"example" : [{
"label" : "General",
"valueString" : "24 hour, 20' post charge"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "v2",
"map" : "OM1-43, OM1-44"
}]
},
{
"id" : "SpecimenDefinition.collection",
"path" : "SpecimenDefinition.collection",
"short" : "Specimen collection procedure",
"definition" : "The action to be performed for collecting the specimen.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SpecimenCollection"
}],
"strength" : "example",
"description" : "The action to collect a type of specimen.",
"valueSet" : "http://hl7.org/fhir/ValueSet/specimen-collection"
}
},
{
"id" : "SpecimenDefinition.typeTested",
"path" : "SpecimenDefinition.typeTested",
"short" : "Specimen in container intended for testing by lab",
"definition" : "Specimen conditioned in a container as expected by the testing laboratory.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "SpecimenDefinition.typeTested.isDerived",
"path" : "SpecimenDefinition.typeTested.isDerived",
"short" : "Primary or secondary specimen",
"definition" : "Primary of secondary specimen.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "boolean"
}],
"example" : [{
"label" : "General",
"valueBoolean" : false
}],
"mapping" : [{
"identity" : "v2",
"map" : "OM4-2"
}]
},
{
"id" : "SpecimenDefinition.typeTested.type",
"path" : "SpecimenDefinition.typeTested.type",
"short" : "Type of intended specimen",
"definition" : "The kind of specimen conditioned for testing expected by lab.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "IntendedSpecimenType"
}],
"strength" : "example",
"description" : "The type of specimen conditioned in a container for lab testing.",
"valueSet" : "http://terminology.hl7.org/ValueSet/v2-0487"
}
},
{
"id" : "SpecimenDefinition.typeTested.preference",
"path" : "SpecimenDefinition.typeTested.preference",
"short" : "preferred | alternate",
"definition" : "The preference for this type of conditioned specimen.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"example" : [{
"label" : "General",
"valueCode" : "preferred, alternate"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SpecimenContainedPreference"
}],
"strength" : "required",
"description" : "Degree of preference of a type of conditioned specimen.",
"valueSet" : "http://hl7.org/fhir/ValueSet/specimen-contained-preference|4.0.1"
},
"mapping" : [{
"identity" : "v2",
"map" : "OM4-16"
}]
},
{
"id" : "SpecimenDefinition.typeTested.container",
"path" : "SpecimenDefinition.typeTested.container",
"short" : "The specimen's container",
"definition" : "The specimen's container.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "SpecimenDefinition.typeTested.container.material",
"path" : "SpecimenDefinition.typeTested.container.material",
"short" : "Container material",
"definition" : "The type of material of the container.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ContainerMaterial"
}],
"strength" : "example",
"description" : "Types of material for specimen containers.",
"valueSet" : "http://hl7.org/fhir/ValueSet/container-material"
}
},
{
"id" : "SpecimenDefinition.typeTested.container.type",
"path" : "SpecimenDefinition.typeTested.container.type",
"short" : "Kind of container associated with the kind of specimen",
"definition" : "The type of container used to contain this kind of specimen.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ContainerType"
}],
"strength" : "example",
"description" : "Type of specimen container.",
"valueSet" : "http://hl7.org/fhir/ValueSet/specimen-container-type"
}
},
{
"id" : "SpecimenDefinition.typeTested.container.cap",
"path" : "SpecimenDefinition.typeTested.container.cap",
"short" : "Color of container cap",
"definition" : "Color of container cap.",
"requirements" : "From ISO 6710-2017 Table F.1 Recommended colour codes.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ContainerCap"
}],
"strength" : "example",
"description" : "Color of the container cap.",
"valueSet" : "http://hl7.org/fhir/ValueSet/container-cap"
}
},
{
"id" : "SpecimenDefinition.typeTested.container.description",
"path" : "SpecimenDefinition.typeTested.container.description",
"short" : "Container description",
"definition" : "The textual description of the kind of container.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"example" : [{
"label" : "General",
"valueString" : "Blue top tube with citrate"
}],
"mapping" : [{
"identity" : "v2",
"map" : "OM4-3"
}]
},
{
"id" : "SpecimenDefinition.typeTested.container.capacity",
"path" : "SpecimenDefinition.typeTested.container.capacity",
"short" : "Container capacity",
"definition" : "The capacity (volume or other measure) of this kind of container.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Quantity",
"profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
}],
"mapping" : [{
"identity" : "v2",
"map" : "OM4-4, OM4-5"
}]
},
{
"id" : "SpecimenDefinition.typeTested.container.minimumVolume[x]",
"path" : "SpecimenDefinition.typeTested.container.minimumVolume[x]",
"short" : "Minimum volume",
"definition" : "The minimum volume to be conditioned in the container.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Quantity",
"profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
},
{
"code" : "string"
}],
"mapping" : [{
"identity" : "v2",
"map" : "OM4-11"
}]
},
{
"id" : "SpecimenDefinition.typeTested.container.additive",
"path" : "SpecimenDefinition.typeTested.container.additive",
"short" : "Additive associated with container",
"definition" : "Substance introduced in the kind of container to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"mapping" : [{
"identity" : "v2",
"map" : "OM4-7"
}]
},
{
"id" : "SpecimenDefinition.typeTested.container.additive.additive[x]",
"path" : "SpecimenDefinition.typeTested.container.additive.additive[x]",
"short" : "Additive associated with container",
"definition" : "Substance introduced in the kind of container to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
},
{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Substance"]
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ContainerAdditive"
}],
"strength" : "example",
"description" : "Substance added to specimen container.",
"valueSet" : "http://terminology.hl7.org/ValueSet/v2-0371"
},
"mapping" : [{
"identity" : "v2",
"map" : "OM4-7"
}]
},
{
"id" : "SpecimenDefinition.typeTested.container.preparation",
"path" : "SpecimenDefinition.typeTested.container.preparation",
"short" : "Specimen container preparation",
"definition" : "Special processing that should be applied to the container for this kind of specimen.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"mapping" : [{
"identity" : "v2",
"map" : "OM4-8"
}]
},
{
"id" : "SpecimenDefinition.typeTested.requirement",
"path" : "SpecimenDefinition.typeTested.requirement",
"short" : "Specimen requirements",
"definition" : "Requirements for delivery and special handling of this kind of conditioned specimen.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"mapping" : [{
"identity" : "v2",
"map" : "OM4-12"
}]
},
{
"id" : "SpecimenDefinition.typeTested.retentionTime",
"path" : "SpecimenDefinition.typeTested.retentionTime",
"short" : "Specimen retention time",
"definition" : "The usual time that a specimen of this kind is retained after the ordered tests are completed, for the purpose of additional testing.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Duration"
}],
"mapping" : [{
"identity" : "v2",
"map" : "OM4-14"
}]
},
{
"id" : "SpecimenDefinition.typeTested.rejectionCriterion",
"path" : "SpecimenDefinition.typeTested.rejectionCriterion",
"short" : "Rejection criterion",
"definition" : "Criterion for rejection of the specimen in its container by the laboratory.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "RejectionCriterion"
}],
"strength" : "example",
"description" : "Criterion for rejection of the specimen by laboratory.",
"valueSet" : "http://hl7.org/fhir/ValueSet/rejection-criteria"
},
"mapping" : [{
"identity" : "v2",
"map" : "OM1-39"
}]
},
{
"id" : "SpecimenDefinition.typeTested.handling",
"path" : "SpecimenDefinition.typeTested.handling",
"short" : "Specimen handling before testing",
"definition" : "Set of instructions for preservation/transport of the specimen at a defined temperature interval, prior the testing process.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "SpecimenDefinition.typeTested.handling.temperatureQualifier",
"path" : "SpecimenDefinition.typeTested.handling.temperatureQualifier",
"short" : "Temperature qualifier",
"definition" : "It qualifies the interval of temperature, which characterizes an occurrence of handling. Conditions that are not related to temperature may be handled in the instruction element.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "HandlingConditionSet"
}],
"strength" : "example",
"description" : "Set of handling instructions prior testing of the specimen.",
"valueSet" : "http://hl7.org/fhir/ValueSet/handling-condition"
},
"mapping" : [{
"identity" : "v2",
"map" : "OM4-15"
}]
},
{
"id" : "SpecimenDefinition.typeTested.handling.temperatureRange",
"path" : "SpecimenDefinition.typeTested.handling.temperatureRange",
"short" : "Temperature range",
"definition" : "The temperature interval for this set of handling instructions.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Range"
}]
},
{
"id" : "SpecimenDefinition.typeTested.handling.maxDuration",
"path" : "SpecimenDefinition.typeTested.handling.maxDuration",
"short" : "Maximum preservation time",
"definition" : "The maximum time interval of preservation of the specimen with these conditions.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Duration"
}]
},
{
"id" : "SpecimenDefinition.typeTested.handling.instruction",
"path" : "SpecimenDefinition.typeTested.handling.instruction",
"short" : "Preservation instruction",
"definition" : "Additional textual instructions for the preservation or transport of the specimen. For instance, 'Protect from light exposure'.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"example" : [{
"label" : "General",
"valueString" : "freeze within 4 hours"
}]
}]
}
}
},
{
"fullUrl" : "http://hl7.org/fhir/StructureDefinition/StructureDefinition",
"resource" : {
"resourceType" : "StructureDefinition",
"id" : "StructureDefinition",
"meta" : {
"lastUpdated" : "2019-11-01T09:29:23.356+11:00"
},
"text" : {
"status" : "generated",
"div" : "Name Flags Card. Type Description & Constraints StructureDefinition IN 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 first element in a differential has no "." in the path and it's not a logical model, it has no type
+ 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: In any snapshot or differential, no label, code or requirements on an element without a "." in the path (e.g. the first element)
+ 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: 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
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension url Σ 1..1 uri Canonical identifier for this structure definition, represented as a URI (globally unique) identifier Σ 0..* Identifier Additional identifier for the structure definition
version Σ 0..1 string Business version of the structure definition name ΣI 1..1 string Name for this structure definition (computer friendly) title Σ 0..1 string Name for this structure definition (human friendly) status ?!Σ 1..1 code draft | active | retired | unknown
PublicationStatus (Required) experimental Σ 0..1 boolean For testing purposes, not real usage date Σ 0..1 dateTime Date last changed publisher Σ 0..1 string Name of the publisher (organization or individual) contact Σ 0..* ContactDetail Contact details for the publisher
description 0..1 markdown Natural language description of the structure definition useContext ΣTU 0..* UsageContext The context that the content is intended to support
jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for structure definition (if applicable)
Jurisdiction (Extensible)
purpose 0..1 markdown Why this structure definition is defined copyright 0..1 markdown Use and/or publishing restrictions keyword Σ 0..* Coding Assist with indexing and finding
Structure Definition Use Codes / Keywords (Extensible)
fhirVersion Σ 0..1 code FHIR Version this StructureDefinition targets
FHIRVersion (Required) mapping I 0..* BackboneElement External specification that the content is mapped to
+ Rule: Must have at least a name or a uri (or both)
identity 1..1 id Internal id when this mapping is used uri I 0..1 uri Identifies what this mapping refers to name I 0..1 string Names what this mapping refers to comment 0..1 string Versions, Issues, Scope limitations etc. kind Σ 1..1 code primitive-type | complex-type | resource | logical
StructureDefinitionKind (Required) abstract Σ 1..1 boolean Whether the structure is abstract context ΣI 0..* BackboneElement If an extension, where it can be used in instances
type Σ 1..1 code fhirpath | element | extension
ExtensionContextType (Required) expression Σ 1..1 string Where the extension can be used in instances contextInvariant ΣI 0..* string FHIRPath invariants - when the extension can be used
type ΣI 1..1 uri Type defined or constrained by this structure
FHIRDefinedType (Extensible) baseDefinition ΣI 0..1 canonical(StructureDefinition) Definition that this type is constrained/specialized from derivation Σ 0..1 code specialization | constraint - How relates to base definition
TypeDerivationRule (Required) snapshot I 0..1 BackboneElement Snapshot view of the structure
+ Rule: Each element definition in a snapshot must have a formal definition and cardinalities
+ 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: All snapshot elements must have a base definition element I 1..* ElementDefinition Definition of elements in the resource (if no StructureDefinition)
+ Rule: provide either a binding reference or a description (or both)
differential I 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 element 1..* ElementDefinition Definition of elements in the resource (if no StructureDefinition)
Documentation for this format
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Foundation.Conformance"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "normative"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode" : "4.0.0"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 5
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "anonymous"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "fhir"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/StructureDefinition",
"version" : "4.0.1",
"name" : "StructureDefinition",
"status" : "active",
"date" : "2019-11-01T09:29:23+11:00",
"publisher" : "Health Level Seven International (FHIR Infrastructure)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/fiwg/index.cfm"
}]
}],
"description" : "A definition of a FHIR structure. This resource is used to describe the underlying resources, data types defined in FHIR, and also for describing extensions and constraints on resources and data types.",
"fhirVersion" : "4.0.1",
"mapping" : [{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
},
{
"identity" : "workflow",
"uri" : "http://hl7.org/fhir/workflow",
"name" : "Workflow Pattern"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/fivews",
"name" : "FiveWs Pattern Mapping"
},
{
"identity" : "iso11179",
"uri" : "http://metadata-standards.org/11179/",
"name" : "ISO 11179"
},
{
"identity" : "objimpl",
"uri" : "http://hl7.org/fhir/object-implementation",
"name" : "Object Implementation Information"
}],
"kind" : "resource",
"abstract" : false,
"type" : "StructureDefinition",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"_baseDefinition" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-codegen-super",
"valueString" : "MetadataResource"
}]
},
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "StructureDefinition",
"path" : "StructureDefinition",
"short" : "Structural Definition",
"definition" : "A definition of a FHIR structure. This resource is used to describe the underlying resources, data types defined in FHIR, and also for describing extensions and constraints on resources and data types.",
"alias" : ["Template",
"Profile"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "StructureDefinition",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "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",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.`div`.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "sdf-0",
"severity" : "warning",
"human" : "Name should be usable as an identifier for the module by machine processing applications such as code generation",
"expression" : "name.matches('[A-Z]([A-Za-z0-9_]){0,254}')",
"xpath" : "not(exists(f:name/@value)) or matches(f:name/@value, '[A-Z]([A-Za-z0-9_]){0,254}')"
},
{
"key" : "sdf-1",
"severity" : "error",
"human" : "Element paths must be unique unless the structure is a constraint",
"expression" : "derivation = 'constraint' or snapshot.element.select(path).isDistinct()",
"xpath" : "(f:derivation/@value = 'constraint') or (count(f:snapshot/f:element) = count(distinct-values(f:snapshot/f:element/f:path/@value)))"
},
{
"key" : "sdf-15a",
"requirements" : "No Type on the root element (differential)",
"severity" : "error",
"human" : "If the first element in a differential has no \".\" in the path and it's not a logical model, it has no type",
"expression" : "(kind!='logical' and differential.element.first().path.contains('.').not()) implies differential.element.first().type.empty()",
"xpath" : "f:kind/@value='logical' or not(f:differential/f:element[1][not(contains(f:path/@value, '.'))]/f:type)"
},
{
"key" : "sdf-4",
"requirements" : "Ensure that the base types are abstract",
"severity" : "error",
"human" : "If the structure is not abstract, then there SHALL be a baseDefinition",
"expression" : "abstract = true or baseDefinition.exists()",
"xpath" : "(f:abstract/@value=true()) or exists(f:baseDefinition)"
},
{
"key" : "sdf-5",
"severity" : "error",
"human" : "If the structure defines an extension then the structure must have context information",
"expression" : "type != 'Extension' or derivation = 'specialization' or (context.exists())",
"xpath" : "not(f:type/@value = 'extension') or (f:derivation/@value = 'specialization') or (exists(f:context))"
},
{
"key" : "sdf-6",
"severity" : "error",
"human" : "A structure must have either a differential, or a snapshot (or both)",
"expression" : "snapshot.exists() or differential.exists()",
"xpath" : "exists(f:snapshot) or exists(f:differential)"
},
{
"key" : "sdf-9",
"requirements" : "Because these 3 fields seem to be have overlapping meaning with the ones in the root of StructureDefinition",
"severity" : "error",
"human" : "In any snapshot or differential, no label, code or requirements on an element without a \".\" in the path (e.g. the first element)",
"expression" : "children().element.where(path.contains('.').not()).label.empty() and children().element.where(path.contains('.').not()).code.empty() and children().element.where(path.contains('.').not()).requirements.empty()",
"xpath" : "not(exists(f:snapshot/f:element[not(contains(f:path/@value, '.')) and (f:label or f:code or f:requirements)])) and not(exists(f:differential/f:element[not(contains(f:path/@value, '.')) and (f:label or f:code or f:requirements)]))"
},
{
"key" : "sdf-11",
"requirements" : "Ensure that the type is not inconsistent with the other information in the structure",
"severity" : "error",
"human" : "If there's a type, its content must match the path name in the first element of a snapshot",
"expression" : "kind != 'logical' implies snapshot.empty() or snapshot.element.first().path = type",
"xpath" : "(f:kind/@value = 'logical') or not(exists(f:snapshot)) or (f:type/@value = f:snapshot/f:element[1]/f:path/@value)"
},
{
"key" : "sdf-14",
"requirements" : "elements have id",
"severity" : "error",
"human" : "All element definitions must have an id",
"expression" : "snapshot.element.all(id.exists()) and differential.element.all(id.exists())",
"xpath" : "count(*/f:element)=count(*/f:element/@id)"
},
{
"key" : "sdf-15",
"requirements" : "No Type on the root element (snapshot)",
"severity" : "error",
"human" : "The first element in a snapshot has no type unless model is a logical model.",
"expression" : "kind!='logical' implies snapshot.element.first().type.empty()",
"xpath" : "f:kind/@value='logical' or not(f:snapshot/f:element[1]/f:type)"
},
{
"key" : "sdf-16",
"requirements" : "element ids need to be unique",
"severity" : "error",
"human" : "All element definitions must have unique ids (snapshot)",
"expression" : "snapshot.element.all(id.exists()) and snapshot.element.id.trace('ids').isDistinct()",
"xpath" : "count(f:snapshot/f:element)=count(f:snapshot/f:element/@id) and (count(f:snapshot/f:element)=count(distinct-values(f:snapshot/f:element/@id)))"
},
{
"key" : "sdf-17",
"requirements" : "element ids need to be unique",
"severity" : "error",
"human" : "All element definitions must have unique ids (diff)",
"expression" : "differential.element.all(id.exists()) and differential.element.id.trace('ids').isDistinct()",
"xpath" : "count(f:differential/f:element)=count(f:differential/f:element/@id) and (count(f:differential/f:element)=count(distinct-values(f:differential/f:element/@id)))"
},
{
"key" : "sdf-18",
"requirements" : "contextInvariant",
"severity" : "error",
"human" : "Context Invariants can only be used for extensions",
"expression" : "contextInvariant.exists() implies type = 'Extension'",
"xpath" : "not(exists(f:contextInvariant)) or (f:type/@value = 'Extension')"
},
{
"key" : "sdf-19",
"requirements" : "custom types only in logical models",
"severity" : "error",
"human" : "FHIR Specification models only use FHIR defined types",
"expression" : "url.startsWith('http://hl7.org/fhir/StructureDefinition') implies (differential.element.type.code.all(matches('^[a-zA-Z0-9]+$') or matches('^http:\\\\/\\\\/hl7\\\\.org\\\\/fhirpath\\\\/System\\\\.[A-Z][A-Za-z]+$')) and snapshot.element.type.code.all(matches('^[a-zA-Z0-9\\\\.]+$') or matches('^http:\\\\/\\\\/hl7\\\\.org\\\\/fhirpath\\\\/System\\\\.[A-Z][A-Za-z]+$')))",
"xpath" : "not(starts-with(f:url/@value, 'http://hl7.org/fhir/StructureDefinition')) or count(f:differential/f:element/f:type/f:code[@value and not(matches(string(@value), '^[a-zA-Z0-9\\.]+$'))]|f:snapshot/f:element/f:type/f:code[@value and not(matches(string(@value), '^[a-zA-Z0-9]+$\\.'))]) =0"
},
{
"key" : "sdf-21",
"requirements" : "no default values on data types or resources",
"severity" : "error",
"human" : "Default values can only be specified on specializations",
"expression" : "differential.element.defaultValue.exists() implies (derivation = 'specialization')",
"xpath" : "not(exists(f:differential/f:element/*[starts-with(local-name(), 'defaultValue')])) or (f:derivation/@value = 'specialization')"
},
{
"key" : "sdf-22",
"requirements" : "no default values on data types or resources",
"severity" : "error",
"human" : "FHIR Specification models never have default values",
"expression" : "url.startsWith('http://hl7.org/fhir/StructureDefinition') implies (snapshot.element.defaultValue.empty() and differential.element.defaultValue.empty())",
"xpath" : "not(starts-with(f:url/@value, 'http://hl7.org/fhir/StructureDefinition')) or (not(exists(f:snapshot/f:element/*[starts-with(local-name(), 'defaultValue')])) and not(exists(f:differential/f:element/*[starts-with(local-name(), 'defaultValue')])))"
},
{
"key" : "sdf-23",
"requirements" : "no sliceName on root",
"severity" : "error",
"human" : "No slice name on root",
"expression" : "(snapshot | differential).element.all(path.contains('.').not() implies sliceName.empty())",
"xpath" : "count(*[self::snapshot or self::differential]/f:element[not(contains(f:path/@value, '.')) and f:sliceName])=0"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "StructureDefinition.id",
"path" : "StructureDefinition.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "StructureDefinition.meta",
"path" : "StructureDefinition.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "StructureDefinition.implicitRules",
"path" : "StructureDefinition.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "StructureDefinition.language",
"path" : "StructureDefinition.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "StructureDefinition.text",
"path" : "StructureDefinition.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "StructureDefinition.contained",
"path" : "StructureDefinition.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "StructureDefinition.extension",
"path" : "StructureDefinition.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "StructureDefinition.modifierExtension",
"path" : "StructureDefinition.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "StructureDefinition.url",
"path" : "StructureDefinition.url",
"short" : "Canonical identifier for this structure definition, represented as a URI (globally unique)",
"definition" : "An absolute URI that is used to identify this structure definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this structure definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the structure definition is stored on different servers.",
"comment" : "Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.\n\nThe determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions). \n\nIn some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.",
"requirements" : "Allows the structure definition to be referenced by a single globally unique identifier.",
"alias" : ["url",
"authoritative-url",
"destination",
"identity"],
"min" : 1,
"max" : "1",
"base" : {
"path" : "StructureDefinition.url",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.url"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
}]
},
{
"id" : "StructureDefinition.identifier",
"path" : "StructureDefinition.identifier",
"short" : "Additional identifier for the structure definition",
"definition" : "A formal identifier that is used to identify this structure definition when it is represented in other formats, or referenced in a specification, model, design or an instance.",
"comment" : "Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this structure definition outside of FHIR, where it is not possible to use the logical URI.",
"requirements" : "Allows externally provided and/or usable business identifiers to be easily associated with the module.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "StructureDefinition.identifier",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Identifier"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.identifier"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "iso11179",
"map" : "Identifier part"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "StructureDefinition.version",
"path" : "StructureDefinition.version",
"short" : "Business version of the structure definition",
"definition" : "The identifier that is used to identify this version of the structure definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the structure definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.",
"comment" : "There may be different structure definition instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the structure definition with the format [url]|[version].",
"min" : 0,
"max" : "1",
"base" : {
"path" : "StructureDefinition.version",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.version"
},
{
"identity" : "w5",
"map" : "FiveWs.version"
},
{
"identity" : "iso11179",
"map" : "Version"
}]
},
{
"id" : "StructureDefinition.name",
"path" : "StructureDefinition.name",
"short" : "Name for this structure definition (computer friendly)",
"definition" : "A natural language name identifying the structure definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.",
"comment" : "The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.Some Examples: \n\n* O2SatObservation\n* PresentationReport\n* Immunization2\n* AcmeAdmissionRecordOld.",
"requirements" : "Support human navigation and code generation.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "StructureDefinition.name",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"condition" : ["inv-0"],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "StructureDefinition.title",
"path" : "StructureDefinition.title",
"short" : "Name for this structure definition (human friendly)",
"definition" : "A short, descriptive, user-friendly title for the structure definition.",
"comment" : "This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.Applications don't have to use this name but can always fall back to it. The title also corresponds to the label for the root element.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "StructureDefinition.title",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.title"
}]
},
{
"id" : "StructureDefinition.status",
"path" : "StructureDefinition.status",
"short" : "draft | active | retired | unknown",
"definition" : "The status of this structure definition. Enables tracking the life-cycle of the content.",
"comment" : "Allows filtering of structure definitions that are appropriate for use versus not.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "StructureDefinition.status",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This is labeled as \"Is Modifier\" because applications should not use a retired {{title}} without due consideration",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "PublicationStatus"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "The lifecycle status of an artifact.",
"valueSet" : "http://hl7.org/fhir/ValueSet/publication-status|4.0.1"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.status"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
},
{
"identity" : "iso11179",
"map" : "Registration status"
}]
},
{
"id" : "StructureDefinition.experimental",
"path" : "StructureDefinition.experimental",
"short" : "For testing purposes, not real usage",
"definition" : "A Boolean value to indicate that this structure definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.",
"comment" : "Allows filtering of structure definitions that are appropriate for use versus not.",
"requirements" : "Enables experimental content to be developed following the same lifecycle that would be used for a production-level structure definition.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "StructureDefinition.experimental",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.experimental"
},
{
"identity" : "w5",
"map" : "FiveWs.class"
},
{
"identity" : "iso11179",
"map" : "Registration status"
}]
},
{
"id" : "StructureDefinition.date",
"path" : "StructureDefinition.date",
"short" : "Date last changed",
"definition" : "The date (and optionally time) when the structure definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the structure definition changes.",
"comment" : "Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the structure definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.",
"alias" : ["Revision Date"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "StructureDefinition.date",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.date"
},
{
"identity" : "w5",
"map" : "FiveWs.recorded"
}]
},
{
"id" : "StructureDefinition.publisher",
"path" : "StructureDefinition.publisher",
"short" : "Name of the publisher (organization or individual)",
"definition" : "The name of the organization or individual that published the structure definition.",
"comment" : "Usually an organization but may be an individual. The publisher (or steward) of the structure definition is the organization or individual primarily responsible for the maintenance and upkeep of the structure definition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the structure definition. This item SHOULD be populated unless the information is available from context.",
"requirements" : "Helps establish the \"authority/credibility\" of the structure definition. May also allow for contact.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "StructureDefinition.publisher",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.publisher"
},
{
"identity" : "w5",
"map" : "FiveWs.witness"
},
{
"identity" : "iso11179",
"map" : "Registration Authority"
}]
},
{
"id" : "StructureDefinition.contact",
"path" : "StructureDefinition.contact",
"short" : "Contact details for the publisher",
"definition" : "Contact details to assist a user in finding and communicating with the publisher.",
"comment" : "May be a web site, an email address, a telephone number, etc.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "StructureDefinition.contact",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "ContactDetail"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.contact"
}]
},
{
"id" : "StructureDefinition.description",
"path" : "StructureDefinition.description",
"short" : "Natural language description of the structure definition",
"definition" : "A free text natural language description of the structure definition from a consumer's perspective.",
"comment" : "This description can be used to capture details such as why the structure definition was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the structure definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the structure definition is presumed to be the predominant language in the place the structure definition was created).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "StructureDefinition.description",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "markdown"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.description"
}]
},
{
"id" : "StructureDefinition.useContext",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"path" : "StructureDefinition.useContext",
"short" : "The context that the content is intended to support",
"definition" : "The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate structure definition instances.",
"comment" : "When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.",
"requirements" : "Assist in searching for appropriate content.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "StructureDefinition.useContext",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "UsageContext"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.useContext"
}]
},
{
"id" : "StructureDefinition.jurisdiction",
"path" : "StructureDefinition.jurisdiction",
"short" : "Intended jurisdiction for structure definition (if applicable)",
"definition" : "A legal or geographic region in which the structure definition is intended to be used.",
"comment" : "It may be possible for the structure definition to be used in jurisdictions other than those for which it was originally designed or intended.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "StructureDefinition.jurisdiction",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Jurisdiction"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "extensible",
"description" : "Countries and regions within which this artifact is targeted for use.",
"valueSet" : "http://hl7.org/fhir/ValueSet/jurisdiction"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.jurisdiction"
}]
},
{
"id" : "StructureDefinition.purpose",
"path" : "StructureDefinition.purpose",
"short" : "Why this structure definition is defined",
"definition" : "Explanation of why this structure definition is needed and why it has been designed as it has.",
"comment" : "This element does not describe the usage of the structure definition. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this structure definition.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "StructureDefinition.purpose",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "markdown"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.purpose"
},
{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "StructureDefinition.copyright",
"path" : "StructureDefinition.copyright",
"short" : "Use and/or publishing restrictions",
"definition" : "A copyright statement relating to the structure definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the structure definition.",
"requirements" : "Consumers must be able to determine any legal restrictions on the use of the structure definition and/or its content.",
"alias" : ["License",
"Restrictions"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "StructureDefinition.copyright",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "markdown"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.copyright"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "StructureDefinition.keyword",
"path" : "StructureDefinition.keyword",
"short" : "Assist with indexing and finding",
"definition" : "A set of key words or terms from external terminologies that may be used to assist with indexing and searching of templates nby describing the use of this structure definition, or the content it describes.",
"requirements" : "Assist in searching for appropriate StructureDefinitions.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "StructureDefinition.keyword",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Coding"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "StructureDefinitionKeyword"
}],
"strength" : "extensible",
"description" : "Codes for the meaning of the defined structure (SNOMED CT and LOINC codes, as an example).",
"valueSet" : "http://hl7.org/fhir/ValueSet/definition-use"
},
"mapping" : [{
"identity" : "iso11179",
"map" : "keywords"
}]
},
{
"id" : "StructureDefinition.fhirVersion",
"path" : "StructureDefinition.fhirVersion",
"short" : "FHIR Version this StructureDefinition targets",
"definition" : "The version of the FHIR specification on which this StructureDefinition is based - this is the formal version of the specification, without the revision number, e.g. [publication].[major].[minor], which is 4.0.1. for this version.",
"comment" : "A StructureDefinition does not need to specify the target it applies to as StructureDefinitions will often be valid across multiple versions of FHIR. FHIR tooling can determine whether a StructureDefinition is consistent with a particular StructureDefinition if desired.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "StructureDefinition.fhirVersion",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "FHIRVersion"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "All published FHIR Versions.",
"valueSet" : "http://hl7.org/fhir/ValueSet/FHIR-version|4.0.1"
}
},
{
"id" : "StructureDefinition.mapping",
"path" : "StructureDefinition.mapping",
"short" : "External specification that the content is mapped to",
"definition" : "An external specification that the content is mapped to.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "StructureDefinition.mapping",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "sdf-2",
"severity" : "error",
"human" : "Must have at least a name or a uri (or both)",
"expression" : "name.exists() or uri.exists()",
"xpath" : "exists(f:uri) or exists(f:name)"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "StructureDefinition.mapping.id",
"path" : "StructureDefinition.mapping.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "StructureDefinition.mapping.extension",
"path" : "StructureDefinition.mapping.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "StructureDefinition.mapping.modifierExtension",
"path" : "StructureDefinition.mapping.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "StructureDefinition.mapping.identity",
"path" : "StructureDefinition.mapping.identity",
"short" : "Internal id when this mapping is used",
"definition" : "An Internal id that is used to identify this mapping set when specific mappings are made.",
"comment" : "The specification is described once, with general comments, and then specific mappings are made that reference this declaration.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "StructureDefinition.mapping.identity",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "id"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "StructureDefinition.mapping.uri",
"path" : "StructureDefinition.mapping.uri",
"short" : "Identifies what this mapping refers to",
"definition" : "An absolute URI that identifies the specification that this mapping is expressed to.",
"comment" : "A formal identity for the specification being mapped to helps with identifying maps consistently.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "StructureDefinition.mapping.uri",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"condition" : ["sdf-2"],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "StructureDefinition.mapping.name",
"path" : "StructureDefinition.mapping.name",
"short" : "Names what this mapping refers to",
"definition" : "A name for the specification that is being mapped to.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "StructureDefinition.mapping.name",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"condition" : ["sdf-2"],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "StructureDefinition.mapping.comment",
"path" : "StructureDefinition.mapping.comment",
"short" : "Versions, Issues, Scope limitations etc.",
"definition" : "Comments about this mapping, including version notes, issues, scope limitations, and other important notes for usage.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "StructureDefinition.mapping.comment",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "StructureDefinition.kind",
"path" : "StructureDefinition.kind",
"short" : "primitive-type | complex-type | resource | logical",
"definition" : "Defines the kind of structure that this definition is describing.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "StructureDefinition.kind",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "StructureDefinitionKind"
}],
"strength" : "required",
"description" : "Defines the type of structure that a definition is describing.",
"valueSet" : "http://hl7.org/fhir/ValueSet/structure-definition-kind|4.0.1"
}
},
{
"id" : "StructureDefinition.abstract",
"path" : "StructureDefinition.abstract",
"short" : "Whether the structure is abstract",
"definition" : "Whether structure this definition describes is abstract or not - that is, whether the structure is not intended to be instantiated. For Resources and Data types, abstract types will never be exchanged between systems.",
"comment" : "Abstract Resources cannot be instantiated - a concrete sub-type must be used. Abstract datatypes and extensions cannot be used in an instance. For logical models, the exact implication of \"abstract\" will rest with the author, depending how the logical model is used. Flagging a constraint structure as abstract conveys design intent but makes no difference to how the structure definition is handled. Note that inline declared elements that are given the type \"Element\" in the StructureDefinition, but have children described, are anonymous concrete types that specialize Element.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "StructureDefinition.abstract",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "StructureDefinition.context",
"path" : "StructureDefinition.context",
"short" : "If an extension, where it can be used in instances",
"definition" : "Identifies the types of resource or data type elements to which the extension can be applied.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "StructureDefinition.context",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"condition" : ["sdf-5"],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "StructureDefinition.context.id",
"path" : "StructureDefinition.context.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "StructureDefinition.context.extension",
"path" : "StructureDefinition.context.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "StructureDefinition.context.modifierExtension",
"path" : "StructureDefinition.context.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "StructureDefinition.context.type",
"path" : "StructureDefinition.context.type",
"short" : "fhirpath | element | extension",
"definition" : "Defines how to interpret the expression that defines what the context of the extension is.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "StructureDefinition.context.type",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ExtensionContextType"
}],
"strength" : "required",
"description" : "How an extension context is interpreted.",
"valueSet" : "http://hl7.org/fhir/ValueSet/extension-context-type|4.0.1"
}
},
{
"id" : "StructureDefinition.context.expression",
"path" : "StructureDefinition.context.expression",
"short" : "Where the extension can be used in instances",
"definition" : "An expression that defines where an extension can be used in resources.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "StructureDefinition.context.expression",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "StructureDefinition.contextInvariant",
"path" : "StructureDefinition.contextInvariant",
"short" : "FHIRPath invariants - when the extension can be used",
"definition" : "A set of rules as FHIRPath Invariants about when the extension can be used (e.g. co-occurrence variants for the extension). All the rules must be true.",
"comment" : "The rules are only evaluated when the extension is present. When evaluating the invariant, the FHIRPath focus is the element that holds the extension, and %extension refers to the extension itself.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "StructureDefinition.contextInvariant",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "string"
}],
"condition" : ["sdf-18"],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "StructureDefinition.type",
"path" : "StructureDefinition.type",
"short" : "Type defined or constrained by this structure",
"definition" : "The type this structure describes. If the derivation kind is 'specialization' then this is the master definition for a type, and there is always one of these (a data type, an extension, a resource, including abstract ones). Otherwise the structure definition is a constraint on the stated type (and in this case, the type cannot be an abstract type). References are URLs that are relative to http://hl7.org/fhir/StructureDefinition e.g. \"string\" is a reference to http://hl7.org/fhir/StructureDefinition/string. Absolute URLs are only allowed in logical models.",
"comment" : "Note that in the case of constraints, the type could be determined by chasing through the baseDefinition references until a concrete structure (derivation = specialization) is reached, or by looking at the path of the first element in the snapshot - if present - but providing the type directly makes for simpler tooling and indexing. \n\nThe type must match the elements defined in the differential and the snapshot. For all FHIR defined types, the path name of the element will start with the type name. For logical models, where the type is a URL, the type name SHOULD start with the tail of the type URL where required.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "StructureDefinition.type",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"condition" : ["sdf-11"],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "FHIRDefinedTypeExt"
}],
"strength" : "extensible",
"description" : "Either a resource or a data type, including logical model types.",
"valueSet" : "http://hl7.org/fhir/ValueSet/defined-types"
}
},
{
"id" : "StructureDefinition.baseDefinition",
"path" : "StructureDefinition.baseDefinition",
"short" : "Definition that this type is constrained/specialized from",
"definition" : "An absolute URI that is the base structure from which this type is derived, either by specialization or constraint.",
"comment" : "If differential constraints are specified in this structure, they are applied to the base in a \"differential\" fashion. If there is no base, then the differential constraints cannot be provided (snapshot only). Differential structures are useful for the editing perspective, and snapshot structures are suitable for operational use. The FHIR Project provides a number of tools/services to populate snapshots from differential constraints. Logical Models have a base of \"Element\" or another logical model.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "StructureDefinition.baseDefinition",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-hierarchy",
"valueBoolean" : true
}],
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/StructureDefinition"]
}],
"condition" : ["sdf-4"],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "StructureDefinition.derivation",
"path" : "StructureDefinition.derivation",
"short" : "specialization | constraint - How relates to base definition",
"definition" : "How the type relates to the baseDefinition.",
"comment" : "If the definition is a specialization, then it adds new elements in the differential, and the snapshot includes the inherited elements. If the definition is a constraint, then it cannot define new elements, it can only make new rules about existing content (see [Profiling Resources](profiling.html#resources)).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "StructureDefinition.derivation",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "TypeDerivationRule"
}],
"strength" : "required",
"description" : "How a type relates to its baseDefinition.",
"valueSet" : "http://hl7.org/fhir/ValueSet/type-derivation-rule|4.0.1"
}
},
{
"id" : "StructureDefinition.snapshot",
"path" : "StructureDefinition.snapshot",
"short" : "Snapshot view of the structure",
"definition" : "A snapshot view is expressed in a standalone form that can be used and interpreted without considering the base StructureDefinition.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "StructureDefinition.snapshot",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "BackboneElement"
}],
"condition" : ["sdf-6"],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "sdf-3",
"severity" : "error",
"human" : "Each element definition in a snapshot must have a formal definition and cardinalities",
"expression" : "element.all(definition.exists() and min.exists() and max.exists())",
"xpath" : "count(f:element) = count(f:element[exists(f:definition) and exists(f:min) and exists(f:max)])"
},
{
"key" : "sdf-8",
"severity" : "error",
"human" : "All snapshot elements must start with the StructureDefinition's specified type for non-logical models, or with the same type name for logical models",
"expression" : "(%resource.kind = 'logical' or element.first().path = %resource.type) and element.tail().all(path.startsWith(%resource.snapshot.element.first().path&'.'))",
"xpath" : "f:element[1]/f:path/@value=parent::f:StructureDefinition/f:type/@value and count(f:element[position()!=1])=count(f:element[position()!=1][starts-with(f:path/@value, concat(ancestor::f:StructureDefinition/f:type/@value, '.'))])"
},
{
"key" : "sdf-8b",
"severity" : "error",
"human" : "All snapshot elements must have a base definition",
"expression" : "element.all(base.exists())",
"xpath" : "count(f:element) = count(f:element/f:base)"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "StructureDefinition.snapshot.id",
"path" : "StructureDefinition.snapshot.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "StructureDefinition.snapshot.extension",
"path" : "StructureDefinition.snapshot.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "StructureDefinition.snapshot.modifierExtension",
"path" : "StructureDefinition.snapshot.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "StructureDefinition.snapshot.element",
"path" : "StructureDefinition.snapshot.element",
"short" : "Definition of elements in the resource (if no StructureDefinition)",
"definition" : "Captures constraints on each element within the resource.",
"min" : 1,
"max" : "*",
"base" : {
"path" : "StructureDefinition.snapshot.element",
"min" : 1,
"max" : "*"
},
"type" : [{
"code" : "ElementDefinition"
}],
"condition" : ["sdf-3"],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "sdf-10",
"requirements" : "binding is required",
"severity" : "error",
"human" : "provide either a binding reference or a description (or both)",
"expression" : "binding.empty() or binding.valueSet.exists() or binding.description.exists()",
"xpath" : "not(exists(f:binding)) or exists(f:binding/f:valueSet) or exists(f:binding/f:description)"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "iso11179",
"map" : "--"
}]
},
{
"id" : "StructureDefinition.differential",
"path" : "StructureDefinition.differential",
"short" : "Differential view of the structure",
"definition" : "A differential view is expressed relative to the base StructureDefinition - a statement of differences that it applies.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "StructureDefinition.differential",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "BackboneElement"
}],
"condition" : ["sdf-6"],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "sdf-20",
"requirements" : "no slicing on root",
"severity" : "error",
"human" : "No slicing on the root element",
"expression" : "element.where(path.contains('.').not()).slicing.empty()",
"xpath" : "not(f:element[1]/f:slicing)"
},
{
"key" : "sdf-8a",
"severity" : "error",
"human" : "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",
"expression" : "(%resource.kind = 'logical' or element.first().path.startsWith(%resource.type)) and (element.tail().empty() or element.tail().all(path.startsWith(%resource.differential.element.first().path.replaceMatches('\\\\..*','')&'.')))",
"xpath" : "count(f:element)=count(f:element[f:path/@value=ancestor::f:StructureDefinition/f:type/@value or starts-with(f:path/@value, concat(ancestor::f:StructureDefinition/f:type/@value, '.'))])"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "StructureDefinition.differential.id",
"path" : "StructureDefinition.differential.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "StructureDefinition.differential.extension",
"path" : "StructureDefinition.differential.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "StructureDefinition.differential.modifierExtension",
"path" : "StructureDefinition.differential.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "StructureDefinition.differential.element",
"path" : "StructureDefinition.differential.element",
"short" : "Definition of elements in the resource (if no StructureDefinition)",
"definition" : "Captures constraints on each element within the resource.",
"min" : 1,
"max" : "*",
"base" : {
"path" : "StructureDefinition.differential.element",
"min" : 1,
"max" : "*"
},
"type" : [{
"code" : "ElementDefinition"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "iso11179",
"map" : "--"
}]
}]
},
"differential" : {
"element" : [{
"id" : "StructureDefinition",
"path" : "StructureDefinition",
"short" : "Structural Definition",
"definition" : "A definition of a FHIR structure. This resource is used to describe the underlying resources, data types defined in FHIR, and also for describing extensions and constraints on resources and data types.",
"alias" : ["Template",
"Profile"],
"min" : 0,
"max" : "*",
"constraint" : [{
"key" : "sdf-9",
"requirements" : "Because these 3 fields seem to be have overlapping meaning with the ones in the root of StructureDefinition",
"severity" : "error",
"human" : "In any snapshot or differential, no label, code or requirements on an element without a \".\" in the path (e.g. the first element)",
"expression" : "children().element.where(path.contains('.').not()).label.empty() and children().element.where(path.contains('.').not()).code.empty() and children().element.where(path.contains('.').not()).requirements.empty()",
"xpath" : "not(exists(f:snapshot/f:element[not(contains(f:path/@value, '.')) and (f:label or f:code or f:requirements)])) and not(exists(f:differential/f:element[not(contains(f:path/@value, '.')) and (f:label or f:code or f:requirements)]))"
},
{
"key" : "sdf-15a",
"requirements" : "No Type on the root element (differential)",
"severity" : "error",
"human" : "If the first element in a differential has no \".\" in the path and it's not a logical model, it has no type",
"expression" : "(kind!='logical' and differential.element.first().path.contains('.').not()) implies differential.element.first().type.empty()",
"xpath" : "f:kind/@value='logical' or not(f:differential/f:element[1][not(contains(f:path/@value, '.'))]/f:type)"
},
{
"key" : "sdf-19",
"requirements" : "custom types only in logical models",
"severity" : "error",
"human" : "FHIR Specification models only use FHIR defined types",
"expression" : "url.startsWith('http://hl7.org/fhir/StructureDefinition') implies (differential.element.type.code.all(matches('^[a-zA-Z0-9]+$') or matches('^http:\\\\/\\\\/hl7\\\\.org\\\\/fhirpath\\\\/System\\\\.[A-Z][A-Za-z]+$')) and snapshot.element.type.code.all(matches('^[a-zA-Z0-9\\\\.]+$') or matches('^http:\\\\/\\\\/hl7\\\\.org\\\\/fhirpath\\\\/System\\\\.[A-Z][A-Za-z]+$')))",
"xpath" : "not(starts-with(f:url/@value, 'http://hl7.org/fhir/StructureDefinition')) or count(f:differential/f:element/f:type/f:code[@value and not(matches(string(@value), '^[a-zA-Z0-9\\.]+$'))]|f:snapshot/f:element/f:type/f:code[@value and not(matches(string(@value), '^[a-zA-Z0-9]+$\\.'))]) =0"
},
{
"key" : "sdf-16",
"requirements" : "element ids need to be unique",
"severity" : "error",
"human" : "All element definitions must have unique ids (snapshot)",
"expression" : "snapshot.element.all(id.exists()) and snapshot.element.id.trace('ids').isDistinct()",
"xpath" : "count(f:snapshot/f:element)=count(f:snapshot/f:element/@id) and (count(f:snapshot/f:element)=count(distinct-values(f:snapshot/f:element/@id)))"
},
{
"key" : "sdf-15",
"requirements" : "No Type on the root element (snapshot)",
"severity" : "error",
"human" : "The first element in a snapshot has no type unless model is a logical model.",
"expression" : "kind!='logical' implies snapshot.element.first().type.empty()",
"xpath" : "f:kind/@value='logical' or not(f:snapshot/f:element[1]/f:type)"
},
{
"key" : "sdf-18",
"requirements" : "contextInvariant",
"severity" : "error",
"human" : "Context Invariants can only be used for extensions",
"expression" : "contextInvariant.exists() implies type = 'Extension'",
"xpath" : "not(exists(f:contextInvariant)) or (f:type/@value = 'Extension')"
},
{
"key" : "sdf-17",
"requirements" : "element ids need to be unique",
"severity" : "error",
"human" : "All element definitions must have unique ids (diff)",
"expression" : "differential.element.all(id.exists()) and differential.element.id.trace('ids').isDistinct()",
"xpath" : "count(f:differential/f:element)=count(f:differential/f:element/@id) and (count(f:differential/f:element)=count(distinct-values(f:differential/f:element/@id)))"
},
{
"key" : "sdf-23",
"requirements" : "no sliceName on root",
"severity" : "error",
"human" : "No slice name on root",
"expression" : "(snapshot | differential).element.all(path.contains('.').not() implies sliceName.empty())",
"xpath" : "count(*[self::snapshot or self::differential]/f:element[not(contains(f:path/@value, '.')) and f:sliceName])=0"
},
{
"key" : "sdf-11",
"requirements" : "Ensure that the type is not inconsistent with the other information in the structure",
"severity" : "error",
"human" : "If there's a type, its content must match the path name in the first element of a snapshot",
"expression" : "kind != 'logical' implies snapshot.empty() or snapshot.element.first().path = type",
"xpath" : "(f:kind/@value = 'logical') or not(exists(f:snapshot)) or (f:type/@value = f:snapshot/f:element[1]/f:path/@value)"
},
{
"key" : "sdf-22",
"requirements" : "no default values on data types or resources",
"severity" : "error",
"human" : "FHIR Specification models never have default values",
"expression" : "url.startsWith('http://hl7.org/fhir/StructureDefinition') implies (snapshot.element.defaultValue.empty() and differential.element.defaultValue.empty())",
"xpath" : "not(starts-with(f:url/@value, 'http://hl7.org/fhir/StructureDefinition')) or (not(exists(f:snapshot/f:element/*[starts-with(local-name(), 'defaultValue')])) and not(exists(f:differential/f:element/*[starts-with(local-name(), 'defaultValue')])))"
},
{
"key" : "sdf-14",
"requirements" : "elements have id",
"severity" : "error",
"human" : "All element definitions must have an id",
"expression" : "snapshot.element.all(id.exists()) and differential.element.all(id.exists())",
"xpath" : "count(*/f:element)=count(*/f:element/@id)"
},
{
"key" : "sdf-1",
"severity" : "error",
"human" : "Element paths must be unique unless the structure is a constraint",
"expression" : "derivation = 'constraint' or snapshot.element.select(path).isDistinct()",
"xpath" : "(f:derivation/@value = 'constraint') or (count(f:snapshot/f:element) = count(distinct-values(f:snapshot/f:element/f:path/@value)))"
},
{
"key" : "sdf-21",
"requirements" : "no default values on data types or resources",
"severity" : "error",
"human" : "Default values can only be specified on specializations",
"expression" : "differential.element.defaultValue.exists() implies (derivation = 'specialization')",
"xpath" : "not(exists(f:differential/f:element/*[starts-with(local-name(), 'defaultValue')])) or (f:derivation/@value = 'specialization')"
},
{
"key" : "sdf-0",
"severity" : "warning",
"human" : "Name should be usable as an identifier for the module by machine processing applications such as code generation",
"expression" : "name.matches('[A-Z]([A-Za-z0-9_]){0,254}')",
"xpath" : "not(exists(f:name/@value)) or matches(f:name/@value, '[A-Z]([A-Za-z0-9_]){0,254}')"
},
{
"key" : "sdf-6",
"severity" : "error",
"human" : "A structure must have either a differential, or a snapshot (or both)",
"expression" : "snapshot.exists() or differential.exists()",
"xpath" : "exists(f:snapshot) or exists(f:differential)"
},
{
"key" : "sdf-5",
"severity" : "error",
"human" : "If the structure defines an extension then the structure must have context information",
"expression" : "type != 'Extension' or derivation = 'specialization' or (context.exists())",
"xpath" : "not(f:type/@value = 'extension') or (f:derivation/@value = 'specialization') or (exists(f:context))"
},
{
"key" : "sdf-4",
"requirements" : "Ensure that the base types are abstract",
"severity" : "error",
"human" : "If the structure is not abstract, then there SHALL be a baseDefinition",
"expression" : "abstract = true or baseDefinition.exists()",
"xpath" : "(f:abstract/@value=true()) or exists(f:baseDefinition)"
}],
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "StructureDefinition.url",
"path" : "StructureDefinition.url",
"short" : "Canonical identifier for this structure definition, represented as a URI (globally unique)",
"definition" : "An absolute URI that is used to identify this structure definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this structure definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the structure definition is stored on different servers.",
"comment" : "Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.\n\nThe determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions). \n\nIn some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.",
"requirements" : "Allows the structure definition to be referenced by a single globally unique identifier.",
"alias" : ["url",
"authoritative-url",
"destination",
"identity"],
"min" : 1,
"max" : "1",
"type" : [{
"code" : "uri"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.url"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
}]
},
{
"id" : "StructureDefinition.identifier",
"path" : "StructureDefinition.identifier",
"short" : "Additional identifier for the structure definition",
"definition" : "A formal identifier that is used to identify this structure definition when it is represented in other formats, or referenced in a specification, model, design or an instance.",
"comment" : "Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this structure definition outside of FHIR, where it is not possible to use the logical URI.",
"requirements" : "Allows externally provided and/or usable business identifiers to be easily associated with the module.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Identifier"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.identifier"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "iso11179",
"map" : "Identifier part"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "StructureDefinition.version",
"path" : "StructureDefinition.version",
"short" : "Business version of the structure definition",
"definition" : "The identifier that is used to identify this version of the structure definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the structure definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.",
"comment" : "There may be different structure definition instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the structure definition with the format [url]|[version].",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.version"
},
{
"identity" : "w5",
"map" : "FiveWs.version"
},
{
"identity" : "iso11179",
"map" : "Version"
}]
},
{
"id" : "StructureDefinition.name",
"path" : "StructureDefinition.name",
"short" : "Name for this structure definition (computer friendly)",
"definition" : "A natural language name identifying the structure definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.",
"comment" : "The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.Some Examples: \n\n* O2SatObservation\n* PresentationReport\n* Immunization2\n* AcmeAdmissionRecordOld.",
"requirements" : "Support human navigation and code generation.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "string"
}],
"condition" : ["inv-0"],
"isSummary" : true
},
{
"id" : "StructureDefinition.title",
"path" : "StructureDefinition.title",
"short" : "Name for this structure definition (human friendly)",
"definition" : "A short, descriptive, user-friendly title for the structure definition.",
"comment" : "This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.Applications don't have to use this name but can always fall back to it. The title also corresponds to the label for the root element.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.title"
}]
},
{
"id" : "StructureDefinition.status",
"path" : "StructureDefinition.status",
"short" : "draft | active | retired | unknown",
"definition" : "The status of this structure definition. Enables tracking the life-cycle of the content.",
"comment" : "Allows filtering of structure definitions that are appropriate for use versus not.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isModifier" : true,
"isModifierReason" : "This is labeled as \"Is Modifier\" because applications should not use a retired {{title}} without due consideration",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "PublicationStatus"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "The lifecycle status of an artifact.",
"valueSet" : "http://hl7.org/fhir/ValueSet/publication-status|4.0.1"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.status"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
},
{
"identity" : "iso11179",
"map" : "Registration status"
}]
},
{
"id" : "StructureDefinition.experimental",
"path" : "StructureDefinition.experimental",
"short" : "For testing purposes, not real usage",
"definition" : "A Boolean value to indicate that this structure definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.",
"comment" : "Allows filtering of structure definitions that are appropriate for use versus not.",
"requirements" : "Enables experimental content to be developed following the same lifecycle that would be used for a production-level structure definition.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "boolean"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.experimental"
},
{
"identity" : "w5",
"map" : "FiveWs.class"
},
{
"identity" : "iso11179",
"map" : "Registration status"
}]
},
{
"id" : "StructureDefinition.date",
"path" : "StructureDefinition.date",
"short" : "Date last changed",
"definition" : "The date (and optionally time) when the structure definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the structure definition changes.",
"comment" : "Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the structure definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.",
"alias" : ["Revision Date"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "dateTime"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.date"
},
{
"identity" : "w5",
"map" : "FiveWs.recorded"
}]
},
{
"id" : "StructureDefinition.publisher",
"path" : "StructureDefinition.publisher",
"short" : "Name of the publisher (organization or individual)",
"definition" : "The name of the organization or individual that published the structure definition.",
"comment" : "Usually an organization but may be an individual. The publisher (or steward) of the structure definition is the organization or individual primarily responsible for the maintenance and upkeep of the structure definition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the structure definition. This item SHOULD be populated unless the information is available from context.",
"requirements" : "Helps establish the \"authority/credibility\" of the structure definition. May also allow for contact.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.publisher"
},
{
"identity" : "w5",
"map" : "FiveWs.witness"
},
{
"identity" : "iso11179",
"map" : "Registration Authority"
}]
},
{
"id" : "StructureDefinition.contact",
"path" : "StructureDefinition.contact",
"short" : "Contact details for the publisher",
"definition" : "Contact details to assist a user in finding and communicating with the publisher.",
"comment" : "May be a web site, an email address, a telephone number, etc.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "ContactDetail"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.contact"
}]
},
{
"id" : "StructureDefinition.description",
"path" : "StructureDefinition.description",
"short" : "Natural language description of the structure definition",
"definition" : "A free text natural language description of the structure definition from a consumer's perspective.",
"comment" : "This description can be used to capture details such as why the structure definition was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the structure definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the structure definition is presumed to be the predominant language in the place the structure definition was created).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "markdown"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.description"
}]
},
{
"id" : "StructureDefinition.useContext",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"path" : "StructureDefinition.useContext",
"short" : "The context that the content is intended to support",
"definition" : "The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate structure definition instances.",
"comment" : "When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.",
"requirements" : "Assist in searching for appropriate content.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "UsageContext"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.useContext"
}]
},
{
"id" : "StructureDefinition.jurisdiction",
"path" : "StructureDefinition.jurisdiction",
"short" : "Intended jurisdiction for structure definition (if applicable)",
"definition" : "A legal or geographic region in which the structure definition is intended to be used.",
"comment" : "It may be possible for the structure definition to be used in jurisdictions other than those for which it was originally designed or intended.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Jurisdiction"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "extensible",
"description" : "Countries and regions within which this artifact is targeted for use.",
"valueSet" : "http://hl7.org/fhir/ValueSet/jurisdiction"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.jurisdiction"
}]
},
{
"id" : "StructureDefinition.purpose",
"path" : "StructureDefinition.purpose",
"short" : "Why this structure definition is defined",
"definition" : "Explanation of why this structure definition is needed and why it has been designed as it has.",
"comment" : "This element does not describe the usage of the structure definition. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this structure definition.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "markdown"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.purpose"
},
{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "StructureDefinition.copyright",
"path" : "StructureDefinition.copyright",
"short" : "Use and/or publishing restrictions",
"definition" : "A copyright statement relating to the structure definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the structure definition.",
"requirements" : "Consumers must be able to determine any legal restrictions on the use of the structure definition and/or its content.",
"alias" : ["License",
"Restrictions"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "markdown"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.copyright"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "StructureDefinition.keyword",
"path" : "StructureDefinition.keyword",
"short" : "Assist with indexing and finding",
"definition" : "A set of key words or terms from external terminologies that may be used to assist with indexing and searching of templates nby describing the use of this structure definition, or the content it describes.",
"requirements" : "Assist in searching for appropriate StructureDefinitions.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Coding"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "StructureDefinitionKeyword"
}],
"strength" : "extensible",
"description" : "Codes for the meaning of the defined structure (SNOMED CT and LOINC codes, as an example).",
"valueSet" : "http://hl7.org/fhir/ValueSet/definition-use"
},
"mapping" : [{
"identity" : "iso11179",
"map" : "keywords"
}]
},
{
"id" : "StructureDefinition.fhirVersion",
"path" : "StructureDefinition.fhirVersion",
"short" : "FHIR Version this StructureDefinition targets",
"definition" : "The version of the FHIR specification on which this StructureDefinition is based - this is the formal version of the specification, without the revision number, e.g. [publication].[major].[minor], which is 4.0.1. for this version.",
"comment" : "A StructureDefinition does not need to specify the target it applies to as StructureDefinitions will often be valid across multiple versions of FHIR. FHIR tooling can determine whether a StructureDefinition is consistent with a particular StructureDefinition if desired.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "FHIRVersion"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "All published FHIR Versions.",
"valueSet" : "http://hl7.org/fhir/ValueSet/FHIR-version|4.0.1"
}
},
{
"id" : "StructureDefinition.mapping",
"path" : "StructureDefinition.mapping",
"short" : "External specification that the content is mapped to",
"definition" : "An external specification that the content is mapped to.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "sdf-2",
"severity" : "error",
"human" : "Must have at least a name or a uri (or both)",
"expression" : "name.exists() or uri.exists()",
"xpath" : "exists(f:uri) or exists(f:name)"
}]
},
{
"id" : "StructureDefinition.mapping.identity",
"path" : "StructureDefinition.mapping.identity",
"short" : "Internal id when this mapping is used",
"definition" : "An Internal id that is used to identify this mapping set when specific mappings are made.",
"comment" : "The specification is described once, with general comments, and then specific mappings are made that reference this declaration.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "id"
}]
},
{
"id" : "StructureDefinition.mapping.uri",
"path" : "StructureDefinition.mapping.uri",
"short" : "Identifies what this mapping refers to",
"definition" : "An absolute URI that identifies the specification that this mapping is expressed to.",
"comment" : "A formal identity for the specification being mapped to helps with identifying maps consistently.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "uri"
}],
"condition" : ["sdf-2"]
},
{
"id" : "StructureDefinition.mapping.name",
"path" : "StructureDefinition.mapping.name",
"short" : "Names what this mapping refers to",
"definition" : "A name for the specification that is being mapped to.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"condition" : ["sdf-2"]
},
{
"id" : "StructureDefinition.mapping.comment",
"path" : "StructureDefinition.mapping.comment",
"short" : "Versions, Issues, Scope limitations etc.",
"definition" : "Comments about this mapping, including version notes, issues, scope limitations, and other important notes for usage.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}]
},
{
"id" : "StructureDefinition.kind",
"path" : "StructureDefinition.kind",
"short" : "primitive-type | complex-type | resource | logical",
"definition" : "Defines the kind of structure that this definition is describing.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "StructureDefinitionKind"
}],
"strength" : "required",
"description" : "Defines the type of structure that a definition is describing.",
"valueSet" : "http://hl7.org/fhir/ValueSet/structure-definition-kind|4.0.1"
}
},
{
"id" : "StructureDefinition.abstract",
"path" : "StructureDefinition.abstract",
"short" : "Whether the structure is abstract",
"definition" : "Whether structure this definition describes is abstract or not - that is, whether the structure is not intended to be instantiated. For Resources and Data types, abstract types will never be exchanged between systems.",
"comment" : "Abstract Resources cannot be instantiated - a concrete sub-type must be used. Abstract datatypes and extensions cannot be used in an instance. For logical models, the exact implication of \"abstract\" will rest with the author, depending how the logical model is used. Flagging a constraint structure as abstract conveys design intent but makes no difference to how the structure definition is handled. Note that inline declared elements that are given the type \"Element\" in the StructureDefinition, but have children described, are anonymous concrete types that specialize Element.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "boolean"
}],
"isSummary" : true
},
{
"id" : "StructureDefinition.context",
"path" : "StructureDefinition.context",
"short" : "If an extension, where it can be used in instances",
"definition" : "Identifies the types of resource or data type elements to which the extension can be applied.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"condition" : ["sdf-5"],
"isSummary" : true
},
{
"id" : "StructureDefinition.context.type",
"path" : "StructureDefinition.context.type",
"short" : "fhirpath | element | extension",
"definition" : "Defines how to interpret the expression that defines what the context of the extension is.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ExtensionContextType"
}],
"strength" : "required",
"description" : "How an extension context is interpreted.",
"valueSet" : "http://hl7.org/fhir/ValueSet/extension-context-type|4.0.1"
}
},
{
"id" : "StructureDefinition.context.expression",
"path" : "StructureDefinition.context.expression",
"short" : "Where the extension can be used in instances",
"definition" : "An expression that defines where an extension can be used in resources.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "StructureDefinition.contextInvariant",
"path" : "StructureDefinition.contextInvariant",
"short" : "FHIRPath invariants - when the extension can be used",
"definition" : "A set of rules as FHIRPath Invariants about when the extension can be used (e.g. co-occurrence variants for the extension). All the rules must be true.",
"comment" : "The rules are only evaluated when the extension is present. When evaluating the invariant, the FHIRPath focus is the element that holds the extension, and %extension refers to the extension itself.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "string"
}],
"condition" : ["sdf-18"],
"isSummary" : true
},
{
"id" : "StructureDefinition.type",
"path" : "StructureDefinition.type",
"short" : "Type defined or constrained by this structure",
"definition" : "The type this structure describes. If the derivation kind is 'specialization' then this is the master definition for a type, and there is always one of these (a data type, an extension, a resource, including abstract ones). Otherwise the structure definition is a constraint on the stated type (and in this case, the type cannot be an abstract type). References are URLs that are relative to http://hl7.org/fhir/StructureDefinition e.g. \"string\" is a reference to http://hl7.org/fhir/StructureDefinition/string. Absolute URLs are only allowed in logical models.",
"comment" : "Note that in the case of constraints, the type could be determined by chasing through the baseDefinition references until a concrete structure (derivation = specialization) is reached, or by looking at the path of the first element in the snapshot - if present - but providing the type directly makes for simpler tooling and indexing. \n\nThe type must match the elements defined in the differential and the snapshot. For all FHIR defined types, the path name of the element will start with the type name. For logical models, where the type is a URL, the type name SHOULD start with the tail of the type URL where required.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "uri"
}],
"condition" : ["sdf-11"],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "FHIRDefinedTypeExt"
}],
"strength" : "extensible",
"description" : "Either a resource or a data type, including logical model types.",
"valueSet" : "http://hl7.org/fhir/ValueSet/defined-types"
}
},
{
"id" : "StructureDefinition.baseDefinition",
"path" : "StructureDefinition.baseDefinition",
"short" : "Definition that this type is constrained/specialized from",
"definition" : "An absolute URI that is the base structure from which this type is derived, either by specialization or constraint.",
"comment" : "If differential constraints are specified in this structure, they are applied to the base in a \"differential\" fashion. If there is no base, then the differential constraints cannot be provided (snapshot only). Differential structures are useful for the editing perspective, and snapshot structures are suitable for operational use. The FHIR Project provides a number of tools/services to populate snapshots from differential constraints. Logical Models have a base of \"Element\" or another logical model.",
"min" : 0,
"max" : "1",
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-hierarchy",
"valueBoolean" : true
}],
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/StructureDefinition"]
}],
"condition" : ["sdf-4"],
"isSummary" : true
},
{
"id" : "StructureDefinition.derivation",
"path" : "StructureDefinition.derivation",
"short" : "specialization | constraint - How relates to base definition",
"definition" : "How the type relates to the baseDefinition.",
"comment" : "If the definition is a specialization, then it adds new elements in the differential, and the snapshot includes the inherited elements. If the definition is a constraint, then it cannot define new elements, it can only make new rules about existing content (see [Profiling Resources](profiling.html#resources)).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "TypeDerivationRule"
}],
"strength" : "required",
"description" : "How a type relates to its baseDefinition.",
"valueSet" : "http://hl7.org/fhir/ValueSet/type-derivation-rule|4.0.1"
}
},
{
"id" : "StructureDefinition.snapshot",
"path" : "StructureDefinition.snapshot",
"short" : "Snapshot view of the structure",
"definition" : "A snapshot view is expressed in a standalone form that can be used and interpreted without considering the base StructureDefinition.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "BackboneElement"
}],
"condition" : ["sdf-6"],
"constraint" : [{
"key" : "sdf-8",
"severity" : "error",
"human" : "All snapshot elements must start with the StructureDefinition's specified type for non-logical models, or with the same type name for logical models",
"expression" : "(%resource.kind = 'logical' or element.first().path = %resource.type) and element.tail().all(path.startsWith(%resource.snapshot.element.first().path&'.'))",
"xpath" : "f:element[1]/f:path/@value=parent::f:StructureDefinition/f:type/@value and count(f:element[position()!=1])=count(f:element[position()!=1][starts-with(f:path/@value, concat(ancestor::f:StructureDefinition/f:type/@value, '.'))])"
},
{
"key" : "sdf-3",
"severity" : "error",
"human" : "Each element definition in a snapshot must have a formal definition and cardinalities",
"expression" : "element.all(definition.exists() and min.exists() and max.exists())",
"xpath" : "count(f:element) = count(f:element[exists(f:definition) and exists(f:min) and exists(f:max)])"
},
{
"key" : "sdf-8b",
"severity" : "error",
"human" : "All snapshot elements must have a base definition",
"expression" : "element.all(base.exists())",
"xpath" : "count(f:element) = count(f:element/f:base)"
}]
},
{
"id" : "StructureDefinition.snapshot.element",
"path" : "StructureDefinition.snapshot.element",
"short" : "Definition of elements in the resource (if no StructureDefinition)",
"definition" : "Captures constraints on each element within the resource.",
"min" : 1,
"max" : "*",
"type" : [{
"code" : "ElementDefinition"
}],
"condition" : ["sdf-3"],
"constraint" : [{
"key" : "sdf-10",
"requirements" : "binding is required",
"severity" : "error",
"human" : "provide either a binding reference or a description (or both)",
"expression" : "binding.empty() or binding.valueSet.exists() or binding.description.exists()",
"xpath" : "not(exists(f:binding)) or exists(f:binding/f:valueSet) or exists(f:binding/f:description)"
}],
"mapping" : [{
"identity" : "iso11179",
"map" : "--"
}]
},
{
"id" : "StructureDefinition.differential",
"path" : "StructureDefinition.differential",
"short" : "Differential view of the structure",
"definition" : "A differential view is expressed relative to the base StructureDefinition - a statement of differences that it applies.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "BackboneElement"
}],
"condition" : ["sdf-6"],
"constraint" : [{
"key" : "sdf-20",
"requirements" : "no slicing on root",
"severity" : "error",
"human" : "No slicing on the root element",
"expression" : "element.where(path.contains('.').not()).slicing.empty()",
"xpath" : "not(f:element[1]/f:slicing)"
},
{
"key" : "sdf-8a",
"severity" : "error",
"human" : "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",
"expression" : "(%resource.kind = 'logical' or element.first().path.startsWith(%resource.type)) and (element.tail().empty() or element.tail().all(path.startsWith(%resource.differential.element.first().path.replaceMatches('\\\\..*','')&'.')))",
"xpath" : "count(f:element)=count(f:element[f:path/@value=ancestor::f:StructureDefinition/f:type/@value or starts-with(f:path/@value, concat(ancestor::f:StructureDefinition/f:type/@value, '.'))])"
}]
},
{
"id" : "StructureDefinition.differential.element",
"path" : "StructureDefinition.differential.element",
"short" : "Definition of elements in the resource (if no StructureDefinition)",
"definition" : "Captures constraints on each element within the resource.",
"min" : 1,
"max" : "*",
"type" : [{
"code" : "ElementDefinition"
}],
"mapping" : [{
"identity" : "iso11179",
"map" : "--"
}]
}]
}
}
},
{
"fullUrl" : "http://hl7.org/fhir/StructureDefinition/StructureMap",
"resource" : {
"resourceType" : "StructureDefinition",
"id" : "StructureMap",
"meta" : {
"lastUpdated" : "2019-11-01T09:29:23.356+11:00"
},
"text" : {
"status" : "generated",
"div" : "Name Flags Card. Type Description & Constraints StructureMap ITU 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 url Σ 1..1 uri Canonical identifier for this structure map, represented as a URI (globally unique) identifier Σ 0..* Identifier Additional identifier for the structure map
version Σ 0..1 string Business version of the structure map name ΣI 1..1 string Name for this structure map (computer friendly) title Σ 0..1 string Name for this structure map (human friendly) status ?!Σ 1..1 code draft | active | retired | unknown
PublicationStatus (Required) experimental Σ 0..1 boolean For testing purposes, not real usage date Σ 0..1 dateTime Date last changed publisher Σ 0..1 string Name of the publisher (organization or individual) contact Σ 0..* ContactDetail Contact details for the publisher
description 0..1 markdown Natural language description of the structure map useContext Σ 0..* UsageContext The context that the content is intended to support
jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for structure map (if applicable)
Jurisdiction (Extensible)
purpose 0..1 markdown Why this structure map is defined copyright 0..1 markdown Use and/or publishing restrictions structure Σ 0..* BackboneElement Structure Definition used by this map
url Σ 1..1 canonical(StructureDefinition) Canonical reference to structure definition mode Σ 1..1 code source | queried | target | produced
StructureMapModelMode (Required) alias Σ 0..1 string Name for type in this map documentation 0..1 string Documentation on use of structure import Σ 0..* canonical(StructureMap) Other maps used by this map (canonical URLs)
group Σ 1..* BackboneElement Named sections for reader convenience
name Σ 1..1 id Human-readable label extends Σ 0..1 id Another group that this group adds rules to typeMode Σ 1..1 code none | types | type-and-types
StructureMapGroupTypeMode (Required) documentation Σ 0..1 string Additional description/explanation for group input Σ 1..* BackboneElement Named instance provided when invoking the map
name Σ 1..1 id Name for this instance of data type Σ 0..1 string Type for this instance of data mode Σ 1..1 code source | target
StructureMapInputMode (Required) documentation 0..1 string Documentation for this instance of data rule Σ 1..* BackboneElement Transform Rule from source to target
name Σ 1..1 id Name of the rule for internal references source Σ 1..* BackboneElement Source inputs to the mapping
context Σ 1..1 id Type or variable this rule applies to min Σ 0..1 integer Specified minimum cardinality max Σ 0..1 string Specified maximum cardinality (number or *) type Σ 0..1 string Rule only applies if source has this type defaultValue[x] Σ 0..1 * Default value if no value exists element Σ 0..1 string Optional field for this source listMode Σ 0..1 code first | not_first | last | not_last | only_one
StructureMapSourceListMode (Required) variable Σ 0..1 id Named context for field, if a field is specified condition Σ 0..1 string FHIRPath expression - must be true or the rule does not apply check Σ 0..1 string FHIRPath expression - must be true or the mapping engine throws an error instead of completing logMessage Σ 0..1 string Message to put in log if source exists (FHIRPath) target ΣI 0..* BackboneElement Content to create because of this mapping rule
+ Rule: Can only have an element if you have a context
+ Rule: Must have a contextType if you have a context
context Σ 0..1 id Type or variable this rule applies to contextType Σ 0..1 code type | variable
StructureMapContextType (Required) element Σ 0..1 string Field to create in the context variable Σ 0..1 id Named context for field, if desired, and a field is specified listMode Σ 0..* code first | share | last | collate
StructureMapTargetListMode (Required)
listRuleId Σ 0..1 id Internal rule reference for shared list items transform Σ 0..1 code create | copy +
StructureMapTransform (Required) parameter Σ 0..* BackboneElement Parameters to the transform
value[x] Σ 1..1 Parameter value - variable or literal valueId id valueString string valueBoolean boolean valueInteger integer valueDecimal decimal rule Σ 0..* see rule Rules contained in this rule
dependent Σ 0..* BackboneElement Which other rules to apply in the context of this rule
name Σ 1..1 id Name of a rule or group to apply variable Σ 1..* string Variable to pass to the rule or group
documentation 0..1 string Documentation for this instance of data
Documentation for this format
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Foundation.Conformance"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 2
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "anonymous"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "fhir"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/StructureMap",
"version" : "4.0.1",
"name" : "StructureMap",
"status" : "draft",
"date" : "2019-11-01T09:29:23+11:00",
"publisher" : "Health Level Seven International (FHIR Infrastructure)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/fiwg/index.cfm"
}]
}],
"description" : "A Map of relationships between 2 structures that can be used to transform data.",
"fhirVersion" : "4.0.1",
"mapping" : [{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
},
{
"identity" : "workflow",
"uri" : "http://hl7.org/fhir/workflow",
"name" : "Workflow Pattern"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/fivews",
"name" : "FiveWs Pattern Mapping"
},
{
"identity" : "objimpl",
"uri" : "http://hl7.org/fhir/object-implementation",
"name" : "Object Implementation Information"
}],
"kind" : "resource",
"abstract" : false,
"type" : "StructureMap",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"_baseDefinition" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-codegen-super",
"valueString" : "MetadataResource"
}]
},
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "StructureMap",
"path" : "StructureMap",
"short" : "A Map of relationships between 2 structures that can be used to transform data",
"definition" : "A Map of relationships between 2 structures that can be used to transform data.",
"alias" : ["Template",
"Profile"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "StructureMap",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "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",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.`div`.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "smp-0",
"severity" : "warning",
"human" : "Name should be usable as an identifier for the module by machine processing applications such as code generation",
"expression" : "name.matches('[A-Z]([A-Za-z0-9_]){0,254}')",
"xpath" : "not(exists(f:name/@value)) or matches(f:name/@value, '[A-Z]([A-Za-z0-9_]){0,254}')"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "StructureMap.id",
"path" : "StructureMap.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "StructureMap.meta",
"path" : "StructureMap.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "StructureMap.implicitRules",
"path" : "StructureMap.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "StructureMap.language",
"path" : "StructureMap.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "StructureMap.text",
"path" : "StructureMap.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "StructureMap.contained",
"path" : "StructureMap.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "StructureMap.extension",
"path" : "StructureMap.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "StructureMap.modifierExtension",
"path" : "StructureMap.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "StructureMap.url",
"path" : "StructureMap.url",
"short" : "Canonical identifier for this structure map, represented as a URI (globally unique)",
"definition" : "An absolute URI that is used to identify this structure map when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this structure map is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the structure map is stored on different servers.",
"comment" : "Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.\n\nThe determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions). \n\nIn some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.",
"requirements" : "Allows the structure map to be referenced by a single globally unique identifier.",
"alias" : ["url",
"authoritative-url",
"destination",
"identity"],
"min" : 1,
"max" : "1",
"base" : {
"path" : "StructureMap.url",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.url"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
}]
},
{
"id" : "StructureMap.identifier",
"path" : "StructureMap.identifier",
"short" : "Additional identifier for the structure map",
"definition" : "A formal identifier that is used to identify this structure map when it is represented in other formats, or referenced in a specification, model, design or an instance.",
"comment" : "Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this structure map outside of FHIR, where it is not possible to use the logical URI.",
"requirements" : "Allows externally provided and/or usable business identifiers to be easily associated with the module.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "StructureMap.identifier",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Identifier"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.identifier"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "StructureMap.version",
"path" : "StructureMap.version",
"short" : "Business version of the structure map",
"definition" : "The identifier that is used to identify this version of the structure map when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the structure map author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.",
"comment" : "There may be different structure map instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the structure map with the format [url]|[version].",
"min" : 0,
"max" : "1",
"base" : {
"path" : "StructureMap.version",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.version"
},
{
"identity" : "w5",
"map" : "FiveWs.version"
}]
},
{
"id" : "StructureMap.name",
"path" : "StructureMap.name",
"short" : "Name for this structure map (computer friendly)",
"definition" : "A natural language name identifying the structure map. This name should be usable as an identifier for the module by machine processing applications such as code generation.",
"comment" : "The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.",
"requirements" : "Support human navigation and code generation.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "StructureMap.name",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"condition" : ["inv-0"],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "StructureMap.title",
"path" : "StructureMap.title",
"short" : "Name for this structure map (human friendly)",
"definition" : "A short, descriptive, user-friendly title for the structure map.",
"comment" : "This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "StructureMap.title",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.title"
}]
},
{
"id" : "StructureMap.status",
"path" : "StructureMap.status",
"short" : "draft | active | retired | unknown",
"definition" : "The status of this structure map. Enables tracking the life-cycle of the content.",
"comment" : "Allows filtering of structure maps that are appropriate for use versus not.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "StructureMap.status",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This is labeled as \"Is Modifier\" because applications should not use a retired {{title}} without due consideration",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "PublicationStatus"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "The lifecycle status of an artifact.",
"valueSet" : "http://hl7.org/fhir/ValueSet/publication-status|4.0.1"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.status"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
}]
},
{
"id" : "StructureMap.experimental",
"path" : "StructureMap.experimental",
"short" : "For testing purposes, not real usage",
"definition" : "A Boolean value to indicate that this structure map is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.",
"comment" : "Allows filtering of structure maps that are appropriate for use versus not.",
"requirements" : "Enables experimental content to be developed following the same lifecycle that would be used for a production-level structure map.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "StructureMap.experimental",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.experimental"
},
{
"identity" : "w5",
"map" : "FiveWs.class"
}]
},
{
"id" : "StructureMap.date",
"path" : "StructureMap.date",
"short" : "Date last changed",
"definition" : "The date (and optionally time) when the structure map was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the structure map changes.",
"comment" : "Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the structure map. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.",
"alias" : ["Revision Date"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "StructureMap.date",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.date"
},
{
"identity" : "w5",
"map" : "FiveWs.recorded"
}]
},
{
"id" : "StructureMap.publisher",
"path" : "StructureMap.publisher",
"short" : "Name of the publisher (organization or individual)",
"definition" : "The name of the organization or individual that published the structure map.",
"comment" : "Usually an organization but may be an individual. The publisher (or steward) of the structure map is the organization or individual primarily responsible for the maintenance and upkeep of the structure map. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the structure map. This item SHOULD be populated unless the information is available from context.",
"requirements" : "Helps establish the \"authority/credibility\" of the structure map. May also allow for contact.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "StructureMap.publisher",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.publisher"
},
{
"identity" : "w5",
"map" : "FiveWs.witness"
}]
},
{
"id" : "StructureMap.contact",
"path" : "StructureMap.contact",
"short" : "Contact details for the publisher",
"definition" : "Contact details to assist a user in finding and communicating with the publisher.",
"comment" : "May be a web site, an email address, a telephone number, etc.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "StructureMap.contact",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "ContactDetail"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.contact"
}]
},
{
"id" : "StructureMap.description",
"path" : "StructureMap.description",
"short" : "Natural language description of the structure map",
"definition" : "A free text natural language description of the structure map from a consumer's perspective.",
"comment" : "This description can be used to capture details such as why the structure map was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the structure map as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the structure map is presumed to be the predominant language in the place the structure map was created).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "StructureMap.description",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "markdown"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.description"
}]
},
{
"id" : "StructureMap.useContext",
"path" : "StructureMap.useContext",
"short" : "The context that the content is intended to support",
"definition" : "The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate structure map instances.",
"comment" : "When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.",
"requirements" : "Assist in searching for appropriate content.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "StructureMap.useContext",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "UsageContext"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.useContext"
}]
},
{
"id" : "StructureMap.jurisdiction",
"path" : "StructureMap.jurisdiction",
"short" : "Intended jurisdiction for structure map (if applicable)",
"definition" : "A legal or geographic region in which the structure map is intended to be used.",
"comment" : "It may be possible for the structure map to be used in jurisdictions other than those for which it was originally designed or intended.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "StructureMap.jurisdiction",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Jurisdiction"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "extensible",
"description" : "Countries and regions within which this artifact is targeted for use.",
"valueSet" : "http://hl7.org/fhir/ValueSet/jurisdiction"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.jurisdiction"
}]
},
{
"id" : "StructureMap.purpose",
"path" : "StructureMap.purpose",
"short" : "Why this structure map is defined",
"definition" : "Explanation of why this structure map is needed and why it has been designed as it has.",
"comment" : "This element does not describe the usage of the structure map. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this structure map.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "StructureMap.purpose",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "markdown"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.purpose"
},
{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "StructureMap.copyright",
"path" : "StructureMap.copyright",
"short" : "Use and/or publishing restrictions",
"definition" : "A copyright statement relating to the structure map and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the structure map.",
"requirements" : "Consumers must be able to determine any legal restrictions on the use of the structure map and/or its content.",
"alias" : ["License",
"Restrictions"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "StructureMap.copyright",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "markdown"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.copyright"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "StructureMap.structure",
"path" : "StructureMap.structure",
"short" : "Structure Definition used by this map",
"definition" : "A structure definition used by this map. The structure definition may describe instances that are converted, or the instances that are produced.",
"comment" : "It is not necessary for a structure map to identify any dependent structures, though not listing them may restrict its usefulness.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "StructureMap.structure",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "StructureMap.structure.id",
"path" : "StructureMap.structure.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "StructureMap.structure.extension",
"path" : "StructureMap.structure.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "StructureMap.structure.modifierExtension",
"path" : "StructureMap.structure.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "StructureMap.structure.url",
"path" : "StructureMap.structure.url",
"short" : "Canonical reference to structure definition",
"definition" : "The canonical reference to the structure.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "StructureMap.structure.url",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/StructureDefinition"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "StructureMap.structure.mode",
"path" : "StructureMap.structure.mode",
"short" : "source | queried | target | produced",
"definition" : "How the referenced structure is used in this mapping.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "StructureMap.structure.mode",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "StructureMapModelMode"
}],
"strength" : "required",
"description" : "How the referenced structure is used in this mapping.",
"valueSet" : "http://hl7.org/fhir/ValueSet/map-model-mode|4.0.1"
}
},
{
"id" : "StructureMap.structure.alias",
"path" : "StructureMap.structure.alias",
"short" : "Name for type in this map",
"definition" : "The name used for this type in the map.",
"comment" : "This is needed if both types have the same name (e.g. version conversion).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "StructureMap.structure.alias",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "StructureMap.structure.documentation",
"path" : "StructureMap.structure.documentation",
"short" : "Documentation on use of structure",
"definition" : "Documentation that describes how the structure is used in the mapping.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "StructureMap.structure.documentation",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "StructureMap.import",
"path" : "StructureMap.import",
"short" : "Other maps used by this map (canonical URLs)",
"definition" : "Other maps used by this map (canonical URLs).",
"min" : 0,
"max" : "*",
"base" : {
"path" : "StructureMap.import",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/StructureMap"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "StructureMap.group",
"path" : "StructureMap.group",
"short" : "Named sections for reader convenience",
"definition" : "Organizes the mapping into manageable chunks for human review/ease of maintenance.",
"min" : 1,
"max" : "*",
"base" : {
"path" : "StructureMap.group",
"min" : 1,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "StructureMap.group.id",
"path" : "StructureMap.group.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "StructureMap.group.extension",
"path" : "StructureMap.group.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "StructureMap.group.modifierExtension",
"path" : "StructureMap.group.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "StructureMap.group.name",
"path" : "StructureMap.group.name",
"short" : "Human-readable label",
"definition" : "A unique name for the group for the convenience of human readers.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "StructureMap.group.name",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "id"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "StructureMap.group.extends",
"path" : "StructureMap.group.extends",
"short" : "Another group that this group adds rules to",
"definition" : "Another group that this group adds rules to.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "StructureMap.group.extends",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "id"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "StructureMap.group.typeMode",
"path" : "StructureMap.group.typeMode",
"short" : "none | types | type-and-types",
"definition" : "If this is the default rule set to apply for the source type or this combination of types.",
"comment" : "Not applicable if the underlying model is untyped. There can only be one default mapping for any particular type combination.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "StructureMap.group.typeMode",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "StructureMapGroupTypeMode"
}],
"strength" : "required",
"description" : "If this is the default rule set to apply for the source type, or this combination of types.",
"valueSet" : "http://hl7.org/fhir/ValueSet/map-group-type-mode|4.0.1"
}
},
{
"id" : "StructureMap.group.documentation",
"path" : "StructureMap.group.documentation",
"short" : "Additional description/explanation for group",
"definition" : "Additional supporting documentation that explains the purpose of the group and the types of mappings within it.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "StructureMap.group.documentation",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "StructureMap.group.input",
"path" : "StructureMap.group.input",
"short" : "Named instance provided when invoking the map",
"definition" : "A name assigned to an instance of data. The instance must be provided when the mapping is invoked.",
"comment" : "If no inputs are named, then the entry mappings are type based.",
"min" : 1,
"max" : "*",
"base" : {
"path" : "StructureMap.group.input",
"min" : 1,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "StructureMap.group.input.id",
"path" : "StructureMap.group.input.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "StructureMap.group.input.extension",
"path" : "StructureMap.group.input.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "StructureMap.group.input.modifierExtension",
"path" : "StructureMap.group.input.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "StructureMap.group.input.name",
"path" : "StructureMap.group.input.name",
"short" : "Name for this instance of data",
"definition" : "Name for this instance of data.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "StructureMap.group.input.name",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "id"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "StructureMap.group.input.type",
"path" : "StructureMap.group.input.type",
"short" : "Type for this instance of data",
"definition" : "Type for this instance of data.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "StructureMap.group.input.type",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "StructureMap.group.input.mode",
"path" : "StructureMap.group.input.mode",
"short" : "source | target",
"definition" : "Mode for this instance of data.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "StructureMap.group.input.mode",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "StructureMapInputMode"
}],
"strength" : "required",
"description" : "Mode for this instance of data.",
"valueSet" : "http://hl7.org/fhir/ValueSet/map-input-mode|4.0.1"
}
},
{
"id" : "StructureMap.group.input.documentation",
"path" : "StructureMap.group.input.documentation",
"short" : "Documentation for this instance of data",
"definition" : "Documentation for this instance of data.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "StructureMap.group.input.documentation",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "StructureMap.group.rule",
"path" : "StructureMap.group.rule",
"short" : "Transform Rule from source to target",
"definition" : "Transform Rule from source to target.",
"min" : 1,
"max" : "*",
"base" : {
"path" : "StructureMap.group.rule",
"min" : 1,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "StructureMap.group.rule.id",
"path" : "StructureMap.group.rule.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "StructureMap.group.rule.extension",
"path" : "StructureMap.group.rule.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "StructureMap.group.rule.modifierExtension",
"path" : "StructureMap.group.rule.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "StructureMap.group.rule.name",
"path" : "StructureMap.group.rule.name",
"short" : "Name of the rule for internal references",
"definition" : "Name of the rule for internal references.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "StructureMap.group.rule.name",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "id"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "StructureMap.group.rule.source",
"path" : "StructureMap.group.rule.source",
"short" : "Source inputs to the mapping",
"definition" : "Source inputs to the mapping.",
"min" : 1,
"max" : "*",
"base" : {
"path" : "StructureMap.group.rule.source",
"min" : 1,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "StructureMap.group.rule.source.id",
"path" : "StructureMap.group.rule.source.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "StructureMap.group.rule.source.extension",
"path" : "StructureMap.group.rule.source.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "StructureMap.group.rule.source.modifierExtension",
"path" : "StructureMap.group.rule.source.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "StructureMap.group.rule.source.context",
"path" : "StructureMap.group.rule.source.context",
"short" : "Type or variable this rule applies to",
"definition" : "Type or variable this rule applies to.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "StructureMap.group.rule.source.context",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "id"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "StructureMap.group.rule.source.min",
"path" : "StructureMap.group.rule.source.min",
"short" : "Specified minimum cardinality",
"definition" : "Specified minimum cardinality for the element. This is optional; if present, it acts an implicit check on the input content.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "StructureMap.group.rule.source.min",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "integer"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "StructureMap.group.rule.source.max",
"path" : "StructureMap.group.rule.source.max",
"short" : "Specified maximum cardinality (number or *)",
"definition" : "Specified maximum cardinality for the element - a number or a \"*\". This is optional; if present, it acts an implicit check on the input content (* just serves as documentation; it's the default value).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "StructureMap.group.rule.source.max",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "StructureMap.group.rule.source.type",
"path" : "StructureMap.group.rule.source.type",
"short" : "Rule only applies if source has this type",
"definition" : "Specified type for the element. This works as a condition on the mapping - use for polymorphic elements.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "StructureMap.group.rule.source.type",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "StructureMap.group.rule.source.defaultValue[x]",
"path" : "StructureMap.group.rule.source.defaultValue[x]",
"short" : "Default value if no value exists",
"definition" : "A value to use if there is no existing value in the source object.",
"comment" : "If there's a default value on an item that can repeat, it will only be used once.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "StructureMap.group.rule.source.defaultValue[x]",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "base64Binary"
},
{
"code" : "boolean"
},
{
"code" : "canonical"
},
{
"code" : "code"
},
{
"code" : "date"
},
{
"code" : "dateTime"
},
{
"code" : "decimal"
},
{
"code" : "id"
},
{
"code" : "instant"
},
{
"code" : "integer"
},
{
"code" : "markdown"
},
{
"code" : "oid"
},
{
"code" : "positiveInt"
},
{
"code" : "string"
},
{
"code" : "time"
},
{
"code" : "unsignedInt"
},
{
"code" : "uri"
},
{
"code" : "url"
},
{
"code" : "uuid"
},
{
"code" : "Address"
},
{
"code" : "Age"
},
{
"code" : "Annotation"
},
{
"code" : "Attachment"
},
{
"code" : "CodeableConcept"
},
{
"code" : "Coding"
},
{
"code" : "ContactPoint"
},
{
"code" : "Count"
},
{
"code" : "Distance"
},
{
"code" : "Duration"
},
{
"code" : "HumanName"
},
{
"code" : "Identifier"
},
{
"code" : "Money"
},
{
"code" : "Period"
},
{
"code" : "Quantity"
},
{
"code" : "Range"
},
{
"code" : "Ratio"
},
{
"code" : "Reference"
},
{
"code" : "SampledData"
},
{
"code" : "Signature"
},
{
"code" : "Timing"
},
{
"code" : "ContactDetail"
},
{
"code" : "Contributor"
},
{
"code" : "DataRequirement"
},
{
"code" : "Expression"
},
{
"code" : "ParameterDefinition"
},
{
"code" : "RelatedArtifact"
},
{
"code" : "TriggerDefinition"
},
{
"code" : "UsageContext"
},
{
"code" : "Dosage"
},
{
"code" : "Meta"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "StructureMap.group.rule.source.element",
"path" : "StructureMap.group.rule.source.element",
"short" : "Optional field for this source",
"definition" : "Optional field for this source.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "StructureMap.group.rule.source.element",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "StructureMap.group.rule.source.listMode",
"path" : "StructureMap.group.rule.source.listMode",
"short" : "first | not_first | last | not_last | only_one",
"definition" : "How to handle the list mode for this element.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "StructureMap.group.rule.source.listMode",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "StructureMapSourceListMode"
}],
"strength" : "required",
"description" : "If field is a list, how to manage the source.",
"valueSet" : "http://hl7.org/fhir/ValueSet/map-source-list-mode|4.0.1"
}
},
{
"id" : "StructureMap.group.rule.source.variable",
"path" : "StructureMap.group.rule.source.variable",
"short" : "Named context for field, if a field is specified",
"definition" : "Named context for field, if a field is specified.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "StructureMap.group.rule.source.variable",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "id"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "StructureMap.group.rule.source.condition",
"path" : "StructureMap.group.rule.source.condition",
"short" : "FHIRPath expression - must be true or the rule does not apply",
"definition" : "FHIRPath expression - must be true or the rule does not apply.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "StructureMap.group.rule.source.condition",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "StructureMap.group.rule.source.check",
"path" : "StructureMap.group.rule.source.check",
"short" : "FHIRPath expression - must be true or the mapping engine throws an error instead of completing",
"definition" : "FHIRPath expression - must be true or the mapping engine throws an error instead of completing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "StructureMap.group.rule.source.check",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "StructureMap.group.rule.source.logMessage",
"path" : "StructureMap.group.rule.source.logMessage",
"short" : "Message to put in log if source exists (FHIRPath)",
"definition" : "A FHIRPath expression which specifies a message to put in the transform log when content matching the source rule is found.",
"comment" : "This is typically used for recording that something Is not transformed to the target for some reason.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "StructureMap.group.rule.source.logMessage",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "StructureMap.group.rule.target",
"path" : "StructureMap.group.rule.target",
"short" : "Content to create because of this mapping rule",
"definition" : "Content to create because of this mapping rule.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "StructureMap.group.rule.target",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "smp-1",
"severity" : "error",
"human" : "Can only have an element if you have a context",
"expression" : "element.exists() implies context.exists()",
"xpath" : "not(f:element) or (f:context)"
},
{
"key" : "smp-2",
"severity" : "error",
"human" : "Must have a contextType if you have a context",
"expression" : "context.exists() implies contextType.exists()",
"xpath" : "not(f:context) or (f:contextType)"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "StructureMap.group.rule.target.id",
"path" : "StructureMap.group.rule.target.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "StructureMap.group.rule.target.extension",
"path" : "StructureMap.group.rule.target.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "StructureMap.group.rule.target.modifierExtension",
"path" : "StructureMap.group.rule.target.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "StructureMap.group.rule.target.context",
"path" : "StructureMap.group.rule.target.context",
"short" : "Type or variable this rule applies to",
"definition" : "Type or variable this rule applies to.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "StructureMap.group.rule.target.context",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "id"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "StructureMap.group.rule.target.contextType",
"path" : "StructureMap.group.rule.target.contextType",
"short" : "type | variable",
"definition" : "How to interpret the context.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "StructureMap.group.rule.target.contextType",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "StructureMapContextType"
}],
"strength" : "required",
"description" : "How to interpret the context.",
"valueSet" : "http://hl7.org/fhir/ValueSet/map-context-type|4.0.1"
}
},
{
"id" : "StructureMap.group.rule.target.element",
"path" : "StructureMap.group.rule.target.element",
"short" : "Field to create in the context",
"definition" : "Field to create in the context.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "StructureMap.group.rule.target.element",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "StructureMap.group.rule.target.variable",
"path" : "StructureMap.group.rule.target.variable",
"short" : "Named context for field, if desired, and a field is specified",
"definition" : "Named context for field, if desired, and a field is specified.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "StructureMap.group.rule.target.variable",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "id"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "StructureMap.group.rule.target.listMode",
"path" : "StructureMap.group.rule.target.listMode",
"short" : "first | share | last | collate",
"definition" : "If field is a list, how to manage the list.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "StructureMap.group.rule.target.listMode",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "StructureMapTargetListMode"
}],
"strength" : "required",
"description" : "If field is a list, how to manage the production.",
"valueSet" : "http://hl7.org/fhir/ValueSet/map-target-list-mode|4.0.1"
}
},
{
"id" : "StructureMap.group.rule.target.listRuleId",
"path" : "StructureMap.group.rule.target.listRuleId",
"short" : "Internal rule reference for shared list items",
"definition" : "Internal rule reference for shared list items.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "StructureMap.group.rule.target.listRuleId",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "id"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "StructureMap.group.rule.target.transform",
"path" : "StructureMap.group.rule.target.transform",
"short" : "create | copy +",
"definition" : "How the data is copied / created.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "StructureMap.group.rule.target.transform",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "StructureMapTransform"
}],
"strength" : "required",
"description" : "How data is copied/created.",
"valueSet" : "http://hl7.org/fhir/ValueSet/map-transform|4.0.1"
}
},
{
"id" : "StructureMap.group.rule.target.parameter",
"path" : "StructureMap.group.rule.target.parameter",
"short" : "Parameters to the transform",
"definition" : "Parameters to the transform.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "StructureMap.group.rule.target.parameter",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "StructureMap.group.rule.target.parameter.id",
"path" : "StructureMap.group.rule.target.parameter.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "StructureMap.group.rule.target.parameter.extension",
"path" : "StructureMap.group.rule.target.parameter.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "StructureMap.group.rule.target.parameter.modifierExtension",
"path" : "StructureMap.group.rule.target.parameter.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "StructureMap.group.rule.target.parameter.value[x]",
"path" : "StructureMap.group.rule.target.parameter.value[x]",
"short" : "Parameter value - variable or literal",
"definition" : "Parameter value - variable or literal.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "StructureMap.group.rule.target.parameter.value[x]",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "id"
},
{
"code" : "string"
},
{
"code" : "boolean"
},
{
"code" : "integer"
},
{
"code" : "decimal"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "StructureMap.group.rule.rule",
"path" : "StructureMap.group.rule.rule",
"short" : "Rules contained in this rule",
"definition" : "Rules contained in this rule.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "StructureMap.group.rule.rule",
"min" : 0,
"max" : "*"
},
"contentReference" : "#StructureMap.group.rule",
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "StructureMap.group.rule.dependent",
"path" : "StructureMap.group.rule.dependent",
"short" : "Which other rules to apply in the context of this rule",
"definition" : "Which other rules to apply in the context of this rule.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "StructureMap.group.rule.dependent",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "StructureMap.group.rule.dependent.id",
"path" : "StructureMap.group.rule.dependent.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "StructureMap.group.rule.dependent.extension",
"path" : "StructureMap.group.rule.dependent.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "StructureMap.group.rule.dependent.modifierExtension",
"path" : "StructureMap.group.rule.dependent.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "StructureMap.group.rule.dependent.name",
"path" : "StructureMap.group.rule.dependent.name",
"short" : "Name of a rule or group to apply",
"definition" : "Name of a rule or group to apply.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "StructureMap.group.rule.dependent.name",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "id"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "StructureMap.group.rule.dependent.variable",
"path" : "StructureMap.group.rule.dependent.variable",
"short" : "Variable to pass to the rule or group",
"definition" : "Variable to pass to the rule or group.",
"min" : 1,
"max" : "*",
"base" : {
"path" : "StructureMap.group.rule.dependent.variable",
"min" : 1,
"max" : "*"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "StructureMap.group.rule.documentation",
"path" : "StructureMap.group.rule.documentation",
"short" : "Documentation for this instance of data",
"definition" : "Documentation for this instance of data.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "StructureMap.group.rule.documentation",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
}]
},
"differential" : {
"element" : [{
"id" : "StructureMap",
"path" : "StructureMap",
"short" : "A Map of relationships between 2 structures that can be used to transform data",
"definition" : "A Map of relationships between 2 structures that can be used to transform data.",
"alias" : ["Template",
"Profile"],
"min" : 0,
"max" : "*",
"constraint" : [{
"key" : "smp-0",
"severity" : "warning",
"human" : "Name should be usable as an identifier for the module by machine processing applications such as code generation",
"expression" : "name.matches('[A-Z]([A-Za-z0-9_]){0,254}')",
"xpath" : "not(exists(f:name/@value)) or matches(f:name/@value, '[A-Z]([A-Za-z0-9_]){0,254}')"
}],
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "StructureMap.url",
"path" : "StructureMap.url",
"short" : "Canonical identifier for this structure map, represented as a URI (globally unique)",
"definition" : "An absolute URI that is used to identify this structure map when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this structure map is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the structure map is stored on different servers.",
"comment" : "Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.\n\nThe determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions). \n\nIn some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.",
"requirements" : "Allows the structure map to be referenced by a single globally unique identifier.",
"alias" : ["url",
"authoritative-url",
"destination",
"identity"],
"min" : 1,
"max" : "1",
"type" : [{
"code" : "uri"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.url"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
}]
},
{
"id" : "StructureMap.identifier",
"path" : "StructureMap.identifier",
"short" : "Additional identifier for the structure map",
"definition" : "A formal identifier that is used to identify this structure map when it is represented in other formats, or referenced in a specification, model, design or an instance.",
"comment" : "Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this structure map outside of FHIR, where it is not possible to use the logical URI.",
"requirements" : "Allows externally provided and/or usable business identifiers to be easily associated with the module.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Identifier"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.identifier"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "StructureMap.version",
"path" : "StructureMap.version",
"short" : "Business version of the structure map",
"definition" : "The identifier that is used to identify this version of the structure map when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the structure map author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.",
"comment" : "There may be different structure map instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the structure map with the format [url]|[version].",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.version"
},
{
"identity" : "w5",
"map" : "FiveWs.version"
}]
},
{
"id" : "StructureMap.name",
"path" : "StructureMap.name",
"short" : "Name for this structure map (computer friendly)",
"definition" : "A natural language name identifying the structure map. This name should be usable as an identifier for the module by machine processing applications such as code generation.",
"comment" : "The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.",
"requirements" : "Support human navigation and code generation.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "string"
}],
"condition" : ["inv-0"],
"isSummary" : true
},
{
"id" : "StructureMap.title",
"path" : "StructureMap.title",
"short" : "Name for this structure map (human friendly)",
"definition" : "A short, descriptive, user-friendly title for the structure map.",
"comment" : "This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.title"
}]
},
{
"id" : "StructureMap.status",
"path" : "StructureMap.status",
"short" : "draft | active | retired | unknown",
"definition" : "The status of this structure map. Enables tracking the life-cycle of the content.",
"comment" : "Allows filtering of structure maps that are appropriate for use versus not.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isModifier" : true,
"isModifierReason" : "This is labeled as \"Is Modifier\" because applications should not use a retired {{title}} without due consideration",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "PublicationStatus"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "The lifecycle status of an artifact.",
"valueSet" : "http://hl7.org/fhir/ValueSet/publication-status|4.0.1"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.status"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
}]
},
{
"id" : "StructureMap.experimental",
"path" : "StructureMap.experimental",
"short" : "For testing purposes, not real usage",
"definition" : "A Boolean value to indicate that this structure map is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.",
"comment" : "Allows filtering of structure maps that are appropriate for use versus not.",
"requirements" : "Enables experimental content to be developed following the same lifecycle that would be used for a production-level structure map.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "boolean"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.experimental"
},
{
"identity" : "w5",
"map" : "FiveWs.class"
}]
},
{
"id" : "StructureMap.date",
"path" : "StructureMap.date",
"short" : "Date last changed",
"definition" : "The date (and optionally time) when the structure map was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the structure map changes.",
"comment" : "Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the structure map. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.",
"alias" : ["Revision Date"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "dateTime"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.date"
},
{
"identity" : "w5",
"map" : "FiveWs.recorded"
}]
},
{
"id" : "StructureMap.publisher",
"path" : "StructureMap.publisher",
"short" : "Name of the publisher (organization or individual)",
"definition" : "The name of the organization or individual that published the structure map.",
"comment" : "Usually an organization but may be an individual. The publisher (or steward) of the structure map is the organization or individual primarily responsible for the maintenance and upkeep of the structure map. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the structure map. This item SHOULD be populated unless the information is available from context.",
"requirements" : "Helps establish the \"authority/credibility\" of the structure map. May also allow for contact.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.publisher"
},
{
"identity" : "w5",
"map" : "FiveWs.witness"
}]
},
{
"id" : "StructureMap.contact",
"path" : "StructureMap.contact",
"short" : "Contact details for the publisher",
"definition" : "Contact details to assist a user in finding and communicating with the publisher.",
"comment" : "May be a web site, an email address, a telephone number, etc.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "ContactDetail"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.contact"
}]
},
{
"id" : "StructureMap.description",
"path" : "StructureMap.description",
"short" : "Natural language description of the structure map",
"definition" : "A free text natural language description of the structure map from a consumer's perspective.",
"comment" : "This description can be used to capture details such as why the structure map was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the structure map as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the structure map is presumed to be the predominant language in the place the structure map was created).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "markdown"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.description"
}]
},
{
"id" : "StructureMap.useContext",
"path" : "StructureMap.useContext",
"short" : "The context that the content is intended to support",
"definition" : "The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate structure map instances.",
"comment" : "When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.",
"requirements" : "Assist in searching for appropriate content.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "UsageContext"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.useContext"
}]
},
{
"id" : "StructureMap.jurisdiction",
"path" : "StructureMap.jurisdiction",
"short" : "Intended jurisdiction for structure map (if applicable)",
"definition" : "A legal or geographic region in which the structure map is intended to be used.",
"comment" : "It may be possible for the structure map to be used in jurisdictions other than those for which it was originally designed or intended.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Jurisdiction"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "extensible",
"description" : "Countries and regions within which this artifact is targeted for use.",
"valueSet" : "http://hl7.org/fhir/ValueSet/jurisdiction"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.jurisdiction"
}]
},
{
"id" : "StructureMap.purpose",
"path" : "StructureMap.purpose",
"short" : "Why this structure map is defined",
"definition" : "Explanation of why this structure map is needed and why it has been designed as it has.",
"comment" : "This element does not describe the usage of the structure map. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this structure map.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "markdown"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.purpose"
},
{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "StructureMap.copyright",
"path" : "StructureMap.copyright",
"short" : "Use and/or publishing restrictions",
"definition" : "A copyright statement relating to the structure map and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the structure map.",
"requirements" : "Consumers must be able to determine any legal restrictions on the use of the structure map and/or its content.",
"alias" : ["License",
"Restrictions"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "markdown"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.copyright"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "StructureMap.structure",
"path" : "StructureMap.structure",
"short" : "Structure Definition used by this map",
"definition" : "A structure definition used by this map. The structure definition may describe instances that are converted, or the instances that are produced.",
"comment" : "It is not necessary for a structure map to identify any dependent structures, though not listing them may restrict its usefulness.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"isSummary" : true
},
{
"id" : "StructureMap.structure.url",
"path" : "StructureMap.structure.url",
"short" : "Canonical reference to structure definition",
"definition" : "The canonical reference to the structure.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/StructureDefinition"]
}],
"isSummary" : true
},
{
"id" : "StructureMap.structure.mode",
"path" : "StructureMap.structure.mode",
"short" : "source | queried | target | produced",
"definition" : "How the referenced structure is used in this mapping.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "StructureMapModelMode"
}],
"strength" : "required",
"description" : "How the referenced structure is used in this mapping.",
"valueSet" : "http://hl7.org/fhir/ValueSet/map-model-mode|4.0.1"
}
},
{
"id" : "StructureMap.structure.alias",
"path" : "StructureMap.structure.alias",
"short" : "Name for type in this map",
"definition" : "The name used for this type in the map.",
"comment" : "This is needed if both types have the same name (e.g. version conversion).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "StructureMap.structure.documentation",
"path" : "StructureMap.structure.documentation",
"short" : "Documentation on use of structure",
"definition" : "Documentation that describes how the structure is used in the mapping.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}]
},
{
"id" : "StructureMap.import",
"path" : "StructureMap.import",
"short" : "Other maps used by this map (canonical URLs)",
"definition" : "Other maps used by this map (canonical URLs).",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/StructureMap"]
}],
"isSummary" : true
},
{
"id" : "StructureMap.group",
"path" : "StructureMap.group",
"short" : "Named sections for reader convenience",
"definition" : "Organizes the mapping into manageable chunks for human review/ease of maintenance.",
"min" : 1,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"isSummary" : true
},
{
"id" : "StructureMap.group.name",
"path" : "StructureMap.group.name",
"short" : "Human-readable label",
"definition" : "A unique name for the group for the convenience of human readers.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "id"
}],
"isSummary" : true
},
{
"id" : "StructureMap.group.extends",
"path" : "StructureMap.group.extends",
"short" : "Another group that this group adds rules to",
"definition" : "Another group that this group adds rules to.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "id"
}],
"isSummary" : true
},
{
"id" : "StructureMap.group.typeMode",
"path" : "StructureMap.group.typeMode",
"short" : "none | types | type-and-types",
"definition" : "If this is the default rule set to apply for the source type or this combination of types.",
"comment" : "Not applicable if the underlying model is untyped. There can only be one default mapping for any particular type combination.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "StructureMapGroupTypeMode"
}],
"strength" : "required",
"description" : "If this is the default rule set to apply for the source type, or this combination of types.",
"valueSet" : "http://hl7.org/fhir/ValueSet/map-group-type-mode|4.0.1"
}
},
{
"id" : "StructureMap.group.documentation",
"path" : "StructureMap.group.documentation",
"short" : "Additional description/explanation for group",
"definition" : "Additional supporting documentation that explains the purpose of the group and the types of mappings within it.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "StructureMap.group.input",
"path" : "StructureMap.group.input",
"short" : "Named instance provided when invoking the map",
"definition" : "A name assigned to an instance of data. The instance must be provided when the mapping is invoked.",
"comment" : "If no inputs are named, then the entry mappings are type based.",
"min" : 1,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"isSummary" : true
},
{
"id" : "StructureMap.group.input.name",
"path" : "StructureMap.group.input.name",
"short" : "Name for this instance of data",
"definition" : "Name for this instance of data.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "id"
}],
"isSummary" : true
},
{
"id" : "StructureMap.group.input.type",
"path" : "StructureMap.group.input.type",
"short" : "Type for this instance of data",
"definition" : "Type for this instance of data.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "StructureMap.group.input.mode",
"path" : "StructureMap.group.input.mode",
"short" : "source | target",
"definition" : "Mode for this instance of data.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "StructureMapInputMode"
}],
"strength" : "required",
"description" : "Mode for this instance of data.",
"valueSet" : "http://hl7.org/fhir/ValueSet/map-input-mode|4.0.1"
}
},
{
"id" : "StructureMap.group.input.documentation",
"path" : "StructureMap.group.input.documentation",
"short" : "Documentation for this instance of data",
"definition" : "Documentation for this instance of data.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}]
},
{
"id" : "StructureMap.group.rule",
"path" : "StructureMap.group.rule",
"short" : "Transform Rule from source to target",
"definition" : "Transform Rule from source to target.",
"min" : 1,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"isSummary" : true
},
{
"id" : "StructureMap.group.rule.name",
"path" : "StructureMap.group.rule.name",
"short" : "Name of the rule for internal references",
"definition" : "Name of the rule for internal references.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "id"
}],
"isSummary" : true
},
{
"id" : "StructureMap.group.rule.source",
"path" : "StructureMap.group.rule.source",
"short" : "Source inputs to the mapping",
"definition" : "Source inputs to the mapping.",
"min" : 1,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"isSummary" : true
},
{
"id" : "StructureMap.group.rule.source.context",
"path" : "StructureMap.group.rule.source.context",
"short" : "Type or variable this rule applies to",
"definition" : "Type or variable this rule applies to.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "id"
}],
"isSummary" : true
},
{
"id" : "StructureMap.group.rule.source.min",
"path" : "StructureMap.group.rule.source.min",
"short" : "Specified minimum cardinality",
"definition" : "Specified minimum cardinality for the element. This is optional; if present, it acts an implicit check on the input content.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "integer"
}],
"isSummary" : true
},
{
"id" : "StructureMap.group.rule.source.max",
"path" : "StructureMap.group.rule.source.max",
"short" : "Specified maximum cardinality (number or *)",
"definition" : "Specified maximum cardinality for the element - a number or a \"*\". This is optional; if present, it acts an implicit check on the input content (* just serves as documentation; it's the default value).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "StructureMap.group.rule.source.type",
"path" : "StructureMap.group.rule.source.type",
"short" : "Rule only applies if source has this type",
"definition" : "Specified type for the element. This works as a condition on the mapping - use for polymorphic elements.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "StructureMap.group.rule.source.defaultValue[x]",
"path" : "StructureMap.group.rule.source.defaultValue[x]",
"short" : "Default value if no value exists",
"definition" : "A value to use if there is no existing value in the source object.",
"comment" : "If there's a default value on an item that can repeat, it will only be used once.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "base64Binary"
},
{
"code" : "boolean"
},
{
"code" : "canonical"
},
{
"code" : "code"
},
{
"code" : "date"
},
{
"code" : "dateTime"
},
{
"code" : "decimal"
},
{
"code" : "id"
},
{
"code" : "instant"
},
{
"code" : "integer"
},
{
"code" : "markdown"
},
{
"code" : "oid"
},
{
"code" : "positiveInt"
},
{
"code" : "string"
},
{
"code" : "time"
},
{
"code" : "unsignedInt"
},
{
"code" : "uri"
},
{
"code" : "url"
},
{
"code" : "uuid"
},
{
"code" : "Address"
},
{
"code" : "Age"
},
{
"code" : "Annotation"
},
{
"code" : "Attachment"
},
{
"code" : "CodeableConcept"
},
{
"code" : "Coding"
},
{
"code" : "ContactPoint"
},
{
"code" : "Count"
},
{
"code" : "Distance"
},
{
"code" : "Duration"
},
{
"code" : "HumanName"
},
{
"code" : "Identifier"
},
{
"code" : "Money"
},
{
"code" : "Period"
},
{
"code" : "Quantity"
},
{
"code" : "Range"
},
{
"code" : "Ratio"
},
{
"code" : "Reference"
},
{
"code" : "SampledData"
},
{
"code" : "Signature"
},
{
"code" : "Timing"
},
{
"code" : "ContactDetail"
},
{
"code" : "Contributor"
},
{
"code" : "DataRequirement"
},
{
"code" : "Expression"
},
{
"code" : "ParameterDefinition"
},
{
"code" : "RelatedArtifact"
},
{
"code" : "TriggerDefinition"
},
{
"code" : "UsageContext"
},
{
"code" : "Dosage"
},
{
"code" : "Meta"
}],
"isSummary" : true
},
{
"id" : "StructureMap.group.rule.source.element",
"path" : "StructureMap.group.rule.source.element",
"short" : "Optional field for this source",
"definition" : "Optional field for this source.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "StructureMap.group.rule.source.listMode",
"path" : "StructureMap.group.rule.source.listMode",
"short" : "first | not_first | last | not_last | only_one",
"definition" : "How to handle the list mode for this element.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "StructureMapSourceListMode"
}],
"strength" : "required",
"description" : "If field is a list, how to manage the source.",
"valueSet" : "http://hl7.org/fhir/ValueSet/map-source-list-mode|4.0.1"
}
},
{
"id" : "StructureMap.group.rule.source.variable",
"path" : "StructureMap.group.rule.source.variable",
"short" : "Named context for field, if a field is specified",
"definition" : "Named context for field, if a field is specified.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "id"
}],
"isSummary" : true
},
{
"id" : "StructureMap.group.rule.source.condition",
"path" : "StructureMap.group.rule.source.condition",
"short" : "FHIRPath expression - must be true or the rule does not apply",
"definition" : "FHIRPath expression - must be true or the rule does not apply.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "StructureMap.group.rule.source.check",
"path" : "StructureMap.group.rule.source.check",
"short" : "FHIRPath expression - must be true or the mapping engine throws an error instead of completing",
"definition" : "FHIRPath expression - must be true or the mapping engine throws an error instead of completing.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "StructureMap.group.rule.source.logMessage",
"path" : "StructureMap.group.rule.source.logMessage",
"short" : "Message to put in log if source exists (FHIRPath)",
"definition" : "A FHIRPath expression which specifies a message to put in the transform log when content matching the source rule is found.",
"comment" : "This is typically used for recording that something Is not transformed to the target for some reason.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "StructureMap.group.rule.target",
"path" : "StructureMap.group.rule.target",
"short" : "Content to create because of this mapping rule",
"definition" : "Content to create because of this mapping rule.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "smp-2",
"severity" : "error",
"human" : "Must have a contextType if you have a context",
"expression" : "context.exists() implies contextType.exists()",
"xpath" : "not(f:context) or (f:contextType)"
},
{
"key" : "smp-1",
"severity" : "error",
"human" : "Can only have an element if you have a context",
"expression" : "element.exists() implies context.exists()",
"xpath" : "not(f:element) or (f:context)"
}],
"isSummary" : true
},
{
"id" : "StructureMap.group.rule.target.context",
"path" : "StructureMap.group.rule.target.context",
"short" : "Type or variable this rule applies to",
"definition" : "Type or variable this rule applies to.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "id"
}],
"isSummary" : true
},
{
"id" : "StructureMap.group.rule.target.contextType",
"path" : "StructureMap.group.rule.target.contextType",
"short" : "type | variable",
"definition" : "How to interpret the context.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "StructureMapContextType"
}],
"strength" : "required",
"description" : "How to interpret the context.",
"valueSet" : "http://hl7.org/fhir/ValueSet/map-context-type|4.0.1"
}
},
{
"id" : "StructureMap.group.rule.target.element",
"path" : "StructureMap.group.rule.target.element",
"short" : "Field to create in the context",
"definition" : "Field to create in the context.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "StructureMap.group.rule.target.variable",
"path" : "StructureMap.group.rule.target.variable",
"short" : "Named context for field, if desired, and a field is specified",
"definition" : "Named context for field, if desired, and a field is specified.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "id"
}],
"isSummary" : true
},
{
"id" : "StructureMap.group.rule.target.listMode",
"path" : "StructureMap.group.rule.target.listMode",
"short" : "first | share | last | collate",
"definition" : "If field is a list, how to manage the list.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "code"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "StructureMapTargetListMode"
}],
"strength" : "required",
"description" : "If field is a list, how to manage the production.",
"valueSet" : "http://hl7.org/fhir/ValueSet/map-target-list-mode|4.0.1"
}
},
{
"id" : "StructureMap.group.rule.target.listRuleId",
"path" : "StructureMap.group.rule.target.listRuleId",
"short" : "Internal rule reference for shared list items",
"definition" : "Internal rule reference for shared list items.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "id"
}],
"isSummary" : true
},
{
"id" : "StructureMap.group.rule.target.transform",
"path" : "StructureMap.group.rule.target.transform",
"short" : "create | copy +",
"definition" : "How the data is copied / created.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "StructureMapTransform"
}],
"strength" : "required",
"description" : "How data is copied/created.",
"valueSet" : "http://hl7.org/fhir/ValueSet/map-transform|4.0.1"
}
},
{
"id" : "StructureMap.group.rule.target.parameter",
"path" : "StructureMap.group.rule.target.parameter",
"short" : "Parameters to the transform",
"definition" : "Parameters to the transform.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"isSummary" : true
},
{
"id" : "StructureMap.group.rule.target.parameter.value[x]",
"path" : "StructureMap.group.rule.target.parameter.value[x]",
"short" : "Parameter value - variable or literal",
"definition" : "Parameter value - variable or literal.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "id"
},
{
"code" : "string"
},
{
"code" : "boolean"
},
{
"code" : "integer"
},
{
"code" : "decimal"
}],
"isSummary" : true
},
{
"id" : "StructureMap.group.rule.rule",
"path" : "StructureMap.group.rule.rule",
"short" : "Rules contained in this rule",
"definition" : "Rules contained in this rule.",
"min" : 0,
"max" : "*",
"contentReference" : "#StructureMap.group.rule",
"isSummary" : true
},
{
"id" : "StructureMap.group.rule.dependent",
"path" : "StructureMap.group.rule.dependent",
"short" : "Which other rules to apply in the context of this rule",
"definition" : "Which other rules to apply in the context of this rule.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"isSummary" : true
},
{
"id" : "StructureMap.group.rule.dependent.name",
"path" : "StructureMap.group.rule.dependent.name",
"short" : "Name of a rule or group to apply",
"definition" : "Name of a rule or group to apply.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "id"
}],
"isSummary" : true
},
{
"id" : "StructureMap.group.rule.dependent.variable",
"path" : "StructureMap.group.rule.dependent.variable",
"short" : "Variable to pass to the rule or group",
"definition" : "Variable to pass to the rule or group.",
"min" : 1,
"max" : "*",
"type" : [{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "StructureMap.group.rule.documentation",
"path" : "StructureMap.group.rule.documentation",
"short" : "Documentation for this instance of data",
"definition" : "Documentation for this instance of data.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}]
}]
}
}
},
{
"fullUrl" : "http://hl7.org/fhir/StructureDefinition/Subscription",
"resource" : {
"resourceType" : "StructureDefinition",
"id" : "Subscription",
"meta" : {
"lastUpdated" : "2019-11-01T09:29:23.356+11:00"
},
"text" : {
"status" : "generated",
"div" : "Name Flags Card. Type Description & Constraints Subscription ΣTU DomainResource Server push subscription criteria
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension status ?!Σ 1..1 code requested | active | error | off
SubscriptionStatus (Required) contact Σ 0..* ContactPoint Contact details for source (e.g. troubleshooting)
end Σ 0..1 instant When to automatically delete the subscription reason Σ 1..1 string Description of why this subscription was created criteria Σ 1..1 string Rule for server push error Σ 0..1 string Latest error note channel Σ 1..1 BackboneElement The channel on which to report matches to the criteria type Σ 1..1 code rest-hook | websocket | email | sms | message
SubscriptionChannelType (Required) endpoint Σ 0..1 url Where the channel points to payload Σ 0..1 code MIME type to send, or omit for no payload
MimeType (Required) header Σ 0..* string Usage depends on the channel type
Documentation for this format
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Foundation.Other"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 3
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "business"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "fhir"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/Subscription",
"version" : "4.0.1",
"name" : "Subscription",
"status" : "draft",
"date" : "2019-11-01T09:29:23+11:00",
"publisher" : "Health Level Seven International (FHIR Infrastructure)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/fiwg/index.cfm"
}]
}],
"description" : "The subscription resource is used to define a push-based subscription from a server to another system. Once a subscription is registered with the server, the server checks every resource that is created or updated, and if the resource matches the given criteria, it sends a message on the defined \"channel\" so that another system can take an appropriate action.",
"fhirVersion" : "4.0.1",
"mapping" : [{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/fivews",
"name" : "FiveWs Pattern Mapping"
}],
"kind" : "resource",
"abstract" : false,
"type" : "Subscription",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "Subscription",
"path" : "Subscription",
"short" : "Server push subscription criteria",
"definition" : "The subscription resource is used to define a push-based subscription from a server to another system. Once a subscription is registered with the server, the server checks every resource that is created or updated, and if the resource matches the given criteria, it sends a message on the defined \"channel\" so that another system can take an appropriate action.",
"alias" : ["WebHook",
"Hook",
"Routing Rule"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Subscription",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "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",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.`div`.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Subscription.id",
"path" : "Subscription.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Subscription.meta",
"path" : "Subscription.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Subscription.implicitRules",
"path" : "Subscription.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "Subscription.language",
"path" : "Subscription.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "Subscription.text",
"path" : "Subscription.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "Subscription.contained",
"path" : "Subscription.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Subscription.extension",
"path" : "Subscription.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Subscription.modifierExtension",
"path" : "Subscription.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Subscription.status",
"path" : "Subscription.status",
"short" : "requested | active | error | off",
"definition" : "The status of the subscription, which marks the server state for managing the subscription.",
"comment" : "A client can only submit subscription resources in the requested or off state. Only the server can move a subscription from requested to active, and then to error. Either the server or the client can turn a subscription off.\n\nThis element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Subscription.status",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SubscriptionStatus"
}],
"strength" : "required",
"description" : "The status of a subscription.",
"valueSet" : "http://hl7.org/fhir/ValueSet/subscription-status|4.0.1"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.status"
}]
},
{
"id" : "Subscription.contact",
"path" : "Subscription.contact",
"short" : "Contact details for source (e.g. troubleshooting)",
"definition" : "Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Subscription.contact",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "ContactPoint"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.subject[x]"
},
{
"identity" : "w5",
"map" : "FiveWs.subject"
}]
},
{
"id" : "Subscription.end",
"path" : "Subscription.end",
"short" : "When to automatically delete the subscription",
"definition" : "The time for the server to turn the subscription off.",
"comment" : "The server is permitted to deviate from this time but should observe it.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Subscription.end",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "instant"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.done[x]"
}]
},
{
"id" : "Subscription.reason",
"path" : "Subscription.reason",
"short" : "Description of why this subscription was created",
"definition" : "A description of why this subscription is defined.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Subscription.reason",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.why[x]"
}]
},
{
"id" : "Subscription.criteria",
"path" : "Subscription.criteria",
"short" : "Rule for server push",
"definition" : "The rules that the server should use to determine when to generate notifications for this subscription.",
"comment" : "The rules are search criteria (without the [base] part). Like Bundle.entry.request.url, it has no leading \"/\".",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Subscription.criteria",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Subscription.error",
"path" : "Subscription.error",
"short" : "Latest error note",
"definition" : "A record of the last error that occurred when the server processed a notification.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Subscription.error",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Subscription.channel",
"path" : "Subscription.channel",
"short" : "The channel on which to report matches to the criteria",
"definition" : "Details where to send notifications when resources are received that meet the criteria.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Subscription.channel",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Subscription.channel.id",
"path" : "Subscription.channel.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Subscription.channel.extension",
"path" : "Subscription.channel.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Subscription.channel.modifierExtension",
"path" : "Subscription.channel.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Subscription.channel.type",
"path" : "Subscription.channel.type",
"short" : "rest-hook | websocket | email | sms | message",
"definition" : "The type of channel to send notifications on.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Subscription.channel.type",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SubscriptionChannelType"
}],
"strength" : "required",
"description" : "The type of method used to execute a subscription.",
"valueSet" : "http://hl7.org/fhir/ValueSet/subscription-channel-type|4.0.1"
}
},
{
"id" : "Subscription.channel.endpoint",
"path" : "Subscription.channel.endpoint",
"short" : "Where the channel points to",
"definition" : "The url that describes the actual end-point to send messages to.",
"comment" : "For rest-hook, and websocket, the end-point must be an http: or https: URL; for email, a mailto: url, for sms, a tel: url, and for message the endpoint can be in any form of url the server understands (usually, http: or mllp:). The URI is allowed to be relative; in which case, it is relative to the server end-point (since there may be more than one, clients should avoid using relative URIs).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Subscription.channel.endpoint",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "url"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Subscription.channel.payload",
"path" : "Subscription.channel.payload",
"short" : "MIME type to send, or omit for no payload",
"definition" : "The mime type to send the payload in - either application/fhir+xml, or application/fhir+json. If the payload is not present, then there is no payload in the notification, just a notification. The mime type \"text/plain\" may also be used for Email and SMS subscriptions.",
"comment" : "Sending the payload has obvious security implications. The server is responsible for ensuring that the content is appropriately secured.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Subscription.channel.payload",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MimeType"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "The mime type of an attachment. Any valid mime type is allowed.",
"valueSet" : "http://hl7.org/fhir/ValueSet/mimetypes|4.0.1"
}
},
{
"id" : "Subscription.channel.header",
"path" : "Subscription.channel.header",
"short" : "Usage depends on the channel type",
"definition" : "Additional headers / information to send as part of the notification.",
"comment" : "Exactly what these mean depend on the channel type. They can convey additional information to the recipient and/or meet security requirements; for example, support of multiple headers in the outgoing notifications for rest-hook type subscriptions.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Subscription.channel.header",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
}]
},
"differential" : {
"element" : [{
"id" : "Subscription",
"path" : "Subscription",
"short" : "Server push subscription criteria",
"definition" : "The subscription resource is used to define a push-based subscription from a server to another system. Once a subscription is registered with the server, the server checks every resource that is created or updated, and if the resource matches the given criteria, it sends a message on the defined \"channel\" so that another system can take an appropriate action.",
"alias" : ["WebHook",
"Hook",
"Routing Rule"],
"min" : 0,
"max" : "*",
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Subscription.status",
"path" : "Subscription.status",
"short" : "requested | active | error | off",
"definition" : "The status of the subscription, which marks the server state for managing the subscription.",
"comment" : "A client can only submit subscription resources in the requested or off state. Only the server can move a subscription from requested to active, and then to error. Either the server or the client can turn a subscription off.\n\nThis element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isModifier" : true,
"isModifierReason" : "This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SubscriptionStatus"
}],
"strength" : "required",
"description" : "The status of a subscription.",
"valueSet" : "http://hl7.org/fhir/ValueSet/subscription-status|4.0.1"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.status"
}]
},
{
"id" : "Subscription.contact",
"path" : "Subscription.contact",
"short" : "Contact details for source (e.g. troubleshooting)",
"definition" : "Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "ContactPoint"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.subject[x]"
},
{
"identity" : "w5",
"map" : "FiveWs.subject"
}]
},
{
"id" : "Subscription.end",
"path" : "Subscription.end",
"short" : "When to automatically delete the subscription",
"definition" : "The time for the server to turn the subscription off.",
"comment" : "The server is permitted to deviate from this time but should observe it.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "instant"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.done[x]"
}]
},
{
"id" : "Subscription.reason",
"path" : "Subscription.reason",
"short" : "Description of why this subscription was created",
"definition" : "A description of why this subscription is defined.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.why[x]"
}]
},
{
"id" : "Subscription.criteria",
"path" : "Subscription.criteria",
"short" : "Rule for server push",
"definition" : "The rules that the server should use to determine when to generate notifications for this subscription.",
"comment" : "The rules are search criteria (without the [base] part). Like Bundle.entry.request.url, it has no leading \"/\".",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "Subscription.error",
"path" : "Subscription.error",
"short" : "Latest error note",
"definition" : "A record of the last error that occurred when the server processed a notification.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "Subscription.channel",
"path" : "Subscription.channel",
"short" : "The channel on which to report matches to the criteria",
"definition" : "Details where to send notifications when resources are received that meet the criteria.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "BackboneElement"
}],
"isSummary" : true
},
{
"id" : "Subscription.channel.type",
"path" : "Subscription.channel.type",
"short" : "rest-hook | websocket | email | sms | message",
"definition" : "The type of channel to send notifications on.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SubscriptionChannelType"
}],
"strength" : "required",
"description" : "The type of method used to execute a subscription.",
"valueSet" : "http://hl7.org/fhir/ValueSet/subscription-channel-type|4.0.1"
}
},
{
"id" : "Subscription.channel.endpoint",
"path" : "Subscription.channel.endpoint",
"short" : "Where the channel points to",
"definition" : "The url that describes the actual end-point to send messages to.",
"comment" : "For rest-hook, and websocket, the end-point must be an http: or https: URL; for email, a mailto: url, for sms, a tel: url, and for message the endpoint can be in any form of url the server understands (usually, http: or mllp:). The URI is allowed to be relative; in which case, it is relative to the server end-point (since there may be more than one, clients should avoid using relative URIs).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "url"
}],
"isSummary" : true
},
{
"id" : "Subscription.channel.payload",
"path" : "Subscription.channel.payload",
"short" : "MIME type to send, or omit for no payload",
"definition" : "The mime type to send the payload in - either application/fhir+xml, or application/fhir+json. If the payload is not present, then there is no payload in the notification, just a notification. The mime type \"text/plain\" may also be used for Email and SMS subscriptions.",
"comment" : "Sending the payload has obvious security implications. The server is responsible for ensuring that the content is appropriately secured.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MimeType"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "The mime type of an attachment. Any valid mime type is allowed.",
"valueSet" : "http://hl7.org/fhir/ValueSet/mimetypes|4.0.1"
}
},
{
"id" : "Subscription.channel.header",
"path" : "Subscription.channel.header",
"short" : "Usage depends on the channel type",
"definition" : "Additional headers / information to send as part of the notification.",
"comment" : "Exactly what these mean depend on the channel type. They can convey additional information to the recipient and/or meet security requirements; for example, support of multiple headers in the outgoing notifications for rest-hook type subscriptions.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "string"
}],
"isSummary" : true
}]
}
}
},
{
"fullUrl" : "http://hl7.org/fhir/StructureDefinition/SubscriptionStatus",
"resource" : {
"resourceType" : "StructureDefinition",
"id" : "SubscriptionStatus",
"meta" : {
"lastUpdated" : "2022-05-28T12:47:40.239+10:00"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Foundation.Other"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "draft"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 0
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "business"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "fhir"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/SubscriptionStatus",
"version" : "4.3.0",
"name" : "SubscriptionStatus",
"status" : "draft",
"experimental" : false,
"date" : "2022-05-28T12:47:40+10:00",
"publisher" : "Health Level Seven International (FHIR Infrastructure)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/fiwg/index.cfm"
}]
}],
"description" : "The SubscriptionStatus resource describes the state of a Subscription during notifications.",
"fhirVersion" : "4.3.0",
"mapping" : [{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/fivews",
"name" : "FiveWs Pattern Mapping"
}],
"kind" : "resource",
"abstract" : false,
"type" : "SubscriptionStatus",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "SubscriptionStatus",
"path" : "SubscriptionStatus",
"short" : "Status information about a Subscription provided during event notification",
"definition" : "The SubscriptionStatus resource describes the state of a Subscription during notifications.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SubscriptionStatus",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "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",
"expression" : "contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $contained in f:contained return $contained[not(exists(parent::*/descendant::f:reference/@value=concat('#', $contained/*/f:id/@value)) or exists(descendant::f:reference[@value='#']))]))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.`div`.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "sst-1",
"severity" : "error",
"human" : "events listed in event notifications",
"expression" : "type = 'event-notification' implies (notificationEvent.exists() and notificationEvent.first().exists())",
"xpath" : "not(f:type/@value='event-notification') or exists(f:notificationEvent[1])",
"source" : "http://hl7.org/fhir/StructureDefinition/SubscriptionStatus"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "rim",
"map" : "N/A"
},
{
"identity" : "w5",
"map" : "infrastructure.exchange"
}]
},
{
"id" : "SubscriptionStatus.id",
"path" : "SubscriptionStatus.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "id"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubscriptionStatus.meta",
"path" : "SubscriptionStatus.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubscriptionStatus.implicitRules",
"path" : "SubscriptionStatus.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "SubscriptionStatus.language",
"path" : "SubscriptionStatus.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "IETF language tag",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "SubscriptionStatus.text",
"path" : "SubscriptionStatus.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "SubscriptionStatus.contained",
"path" : "SubscriptionStatus.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"constraint" : [{
"key" : "dom-r4b",
"severity" : "warning",
"human" : "Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems",
"expression" : "($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)",
"xpath" : "not(f:Citation|f:Evidence|f:EvidenceReport|f:EvidenceVariable|f:MedicinalProductDefinition|f:PackagedProductDefinition|f:AdministrableProductDefinition|f:Ingredient|f:ClinicalUseDefinition|f:RegulatedAuthorization|f:SubstanceDefinition|f:SubscriptionStatus|f:SubscriptionTopic) or not(parent::f:Citation|parent::f:Evidence|parent::f:EvidenceReport|parent::f:EvidenceVariable|parent::f:MedicinalProductDefinition|parent::f:PackagedProductDefinition|parent::f:AdministrableProductDefinition|parent::f:Ingredient|parent::f:ClinicalUseDefinition|parent::f:RegulatedAuthorization|parent::f:SubstanceDefinition|f:SubscriptionStatus|f:SubscriptionTopic)",
"source" : "http://hl7.org/fhir/StructureDefinition/SubscriptionStatus"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "SubscriptionStatus.extension",
"path" : "SubscriptionStatus.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "SubscriptionStatus.modifierExtension",
"path" : "SubscriptionStatus.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"mustSupport" : false,
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "SubscriptionStatus.status",
"path" : "SubscriptionStatus.status",
"short" : "requested | active | error | off | entered-in-error",
"definition" : "The status of the subscription, which marks the server state for managing the subscription.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubscriptionStatus.status",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SubscriptionStatus"
}],
"strength" : "required",
"description" : "The status of a subscription at the time this notification was generated.",
"valueSet" : "http://hl7.org/fhir/ValueSet/subscription-status|4.3.0"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.status"
}]
},
{
"id" : "SubscriptionStatus.type",
"path" : "SubscriptionStatus.type",
"short" : "handshake | heartbeat | event-notification | query-status | query-event",
"definition" : "The type of event being conveyed with this notificaiton.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "SubscriptionStatus.type",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : true,
"isModifierReason" : "Not known why this is labelled a modifier",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SubscriptionNotificationType"
}],
"strength" : "required",
"description" : "The type of notification represented by the status message.",
"valueSet" : "http://hl7.org/fhir/ValueSet/subscription-notification-type|4.3.0"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.what[x]"
}]
},
{
"id" : "SubscriptionStatus.eventsSinceSubscriptionStart",
"path" : "SubscriptionStatus.eventsSinceSubscriptionStart",
"short" : "Events since the Subscription was created",
"definition" : "The total number of actual events which have been generated since the Subscription was created (inclusive of this notification) - regardless of how many have been successfully communicated. This number is NOT incremented for handshake and heartbeat notifications.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubscriptionStatus.eventsSinceSubscriptionStart",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubscriptionStatus.notificationEvent",
"path" : "SubscriptionStatus.notificationEvent",
"short" : "Detailed information about any events relevant to this notification",
"definition" : "Detailed information about events relevant to this subscription notification.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SubscriptionStatus.notificationEvent",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children unless an empty Parameters resource",
"expression" : "hasValue() or (children().count() > id.count()) or $this is Parameters",
"xpath" : "@value|f:*|h:div|self::f:Parameters",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false
},
{
"id" : "SubscriptionStatus.notificationEvent.id",
"path" : "SubscriptionStatus.notificationEvent.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "SubscriptionStatus.notificationEvent.extension",
"path" : "SubscriptionStatus.notificationEvent.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "SubscriptionStatus.notificationEvent.modifierExtension",
"path" : "SubscriptionStatus.notificationEvent.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "SubscriptionStatus.notificationEvent.eventNumber",
"path" : "SubscriptionStatus.notificationEvent.eventNumber",
"short" : "Event number",
"definition" : "The sequential number of this event in this subscription context. Note that this value is a 64-bit integer value, encoded as a string.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "SubscriptionStatus.notificationEvent.eventNumber",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false
},
{
"id" : "SubscriptionStatus.notificationEvent.timestamp",
"path" : "SubscriptionStatus.notificationEvent.timestamp",
"short" : "The instant this event occurred",
"definition" : "The actual time this event occured on the server.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubscriptionStatus.notificationEvent.timestamp",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "instant"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false
},
{
"id" : "SubscriptionStatus.notificationEvent.focus",
"path" : "SubscriptionStatus.notificationEvent.focus",
"short" : "The focus of this event",
"definition" : "The focus of this event. While this will usually be a reference to the focus resource of the event, it MAY contain a reference to a non-FHIR object.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubscriptionStatus.notificationEvent.focus",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false
},
{
"id" : "SubscriptionStatus.notificationEvent.additionalContext",
"path" : "SubscriptionStatus.notificationEvent.additionalContext",
"short" : "Additional context for this event",
"definition" : "Additional context information for this event. Generally, this will contain references to additional resources included with the event (e.g., the Patient relevant to an Encounter), however it MAY refer to non-FHIR objects.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SubscriptionStatus.notificationEvent.additionalContext",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false
},
{
"id" : "SubscriptionStatus.subscription",
"path" : "SubscriptionStatus.subscription",
"short" : "Reference to the Subscription responsible for this notification",
"definition" : "The reference to the Subscription which generated this notification.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "SubscriptionStatus.subscription",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Subscription"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.why[x]"
}]
},
{
"id" : "SubscriptionStatus.topic",
"path" : "SubscriptionStatus.topic",
"short" : "Reference to the SubscriptionTopic this notification relates to",
"definition" : "The reference to the SubscriptionTopic for the Subscription which generated this notification.",
"comment" : "This value SHOULD NOT be present when using `empty` payloads, MAY be present when using `id-only` payloads, and SHOULD be present when using `full-resource` payloads.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubscriptionStatus.topic",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/SubscriptionTopic"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubscriptionStatus.error",
"path" : "SubscriptionStatus.error",
"short" : "List of errors on the subscription",
"definition" : "A record of errors that occurred when the server processed a notification.",
"comment" : "Recommended practice: clear errors when status is updated.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SubscriptionStatus.error",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SubscriptionError"
}],
"strength" : "example",
"description" : "Codes to represent subscription error details.",
"valueSet" : "http://hl7.org/fhir/ValueSet/subscription-error"
}
}]
},
"differential" : {
"element" : [{
"id" : "SubscriptionStatus",
"path" : "SubscriptionStatus",
"short" : "Status information about a Subscription provided during event notification",
"definition" : "The SubscriptionStatus resource describes the state of a Subscription during notifications.",
"min" : 0,
"max" : "*",
"constraint" : [{
"key" : "sst-1",
"severity" : "error",
"human" : "events listed in event notifications",
"expression" : "type = 'event-notification' implies (notificationEvent.exists() and notificationEvent.first().exists())",
"xpath" : "not(f:type/@value='event-notification') or exists(f:notificationEvent[1])",
"source" : "http://hl7.org/fhir/StructureDefinition/SubscriptionStatus"
}],
"mustSupport" : false,
"isModifier" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
},
{
"identity" : "w5",
"map" : "infrastructure.exchange"
}]
},
{
"id" : "SubscriptionStatus.status",
"path" : "SubscriptionStatus.status",
"short" : "requested | active | error | off | entered-in-error",
"definition" : "The status of the subscription, which marks the server state for managing the subscription.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "code"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SubscriptionStatus"
}],
"strength" : "required",
"description" : "The status of a subscription at the time this notification was generated.",
"valueSet" : "http://hl7.org/fhir/ValueSet/subscription-status|4.3.0"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.status"
}]
},
{
"id" : "SubscriptionStatus.type",
"path" : "SubscriptionStatus.type",
"short" : "handshake | heartbeat | event-notification | query-status | query-event",
"definition" : "The type of event being conveyed with this notificaiton.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"mustSupport" : false,
"isModifier" : true,
"isModifierReason" : "Not known why this is labelled a modifier",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SubscriptionNotificationType"
}],
"strength" : "required",
"description" : "The type of notification represented by the status message.",
"valueSet" : "http://hl7.org/fhir/ValueSet/subscription-notification-type|4.3.0"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.what[x]"
}]
},
{
"id" : "SubscriptionStatus.eventsSinceSubscriptionStart",
"path" : "SubscriptionStatus.eventsSinceSubscriptionStart",
"short" : "Events since the Subscription was created",
"definition" : "The total number of actual events which have been generated since the Subscription was created (inclusive of this notification) - regardless of how many have been successfully communicated. This number is NOT incremented for handshake and heartbeat notifications.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubscriptionStatus.notificationEvent",
"path" : "SubscriptionStatus.notificationEvent",
"short" : "Detailed information about any events relevant to this notification",
"definition" : "Detailed information about events relevant to this subscription notification.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false
},
{
"id" : "SubscriptionStatus.notificationEvent.eventNumber",
"path" : "SubscriptionStatus.notificationEvent.eventNumber",
"short" : "Event number",
"definition" : "The sequential number of this event in this subscription context. Note that this value is a 64-bit integer value, encoded as a string.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "string"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false
},
{
"id" : "SubscriptionStatus.notificationEvent.timestamp",
"path" : "SubscriptionStatus.notificationEvent.timestamp",
"short" : "The instant this event occurred",
"definition" : "The actual time this event occured on the server.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "instant"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false
},
{
"id" : "SubscriptionStatus.notificationEvent.focus",
"path" : "SubscriptionStatus.notificationEvent.focus",
"short" : "The focus of this event",
"definition" : "The focus of this event. While this will usually be a reference to the focus resource of the event, it MAY contain a reference to a non-FHIR object.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false
},
{
"id" : "SubscriptionStatus.notificationEvent.additionalContext",
"path" : "SubscriptionStatus.notificationEvent.additionalContext",
"short" : "Additional context for this event",
"definition" : "Additional context information for this event. Generally, this will contain references to additional resources included with the event (e.g., the Patient relevant to an Encounter), however it MAY refer to non-FHIR objects.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false
},
{
"id" : "SubscriptionStatus.subscription",
"path" : "SubscriptionStatus.subscription",
"short" : "Reference to the Subscription responsible for this notification",
"definition" : "The reference to the Subscription which generated this notification.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Subscription"]
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.why[x]"
}]
},
{
"id" : "SubscriptionStatus.topic",
"path" : "SubscriptionStatus.topic",
"short" : "Reference to the SubscriptionTopic this notification relates to",
"definition" : "The reference to the SubscriptionTopic for the Subscription which generated this notification.",
"comment" : "This value SHOULD NOT be present when using `empty` payloads, MAY be present when using `id-only` payloads, and SHOULD be present when using `full-resource` payloads.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/SubscriptionTopic"]
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubscriptionStatus.error",
"path" : "SubscriptionStatus.error",
"short" : "List of errors on the subscription",
"definition" : "A record of errors that occurred when the server processed a notification.",
"comment" : "Recommended practice: clear errors when status is updated.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SubscriptionError"
}],
"strength" : "example",
"description" : "Codes to represent subscription error details.",
"valueSet" : "http://hl7.org/fhir/ValueSet/subscription-error"
}
}]
}
}
},
{
"fullUrl" : "http://hl7.org/fhir/StructureDefinition/Substance",
"resource" : {
"resourceType" : "StructureDefinition",
"id" : "Substance",
"meta" : {
"lastUpdated" : "2019-11-01T09:29:23.356+11:00"
},
"text" : {
"status" : "generated",
"div" : "Name Flags Card. Type Description & Constraints Substance TU DomainResource A homogeneous material with a definite composition
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension identifier Σ 0..* Identifier Unique identifier
status ?!Σ 0..1 code active | inactive | entered-in-error
FHIRSubstanceStatus (Required) category Σ 0..* CodeableConcept What class/type of substance this is
Substance Category Codes (Extensible)
code Σ 1..1 CodeableConcept What substance this is
Substance Code (Example) description Σ 0..1 string Textual description of the substance, comments instance Σ 0..* BackboneElement If this describes a specific package/container of the substance
identifier Σ 0..1 Identifier Identifier of the package/container expiry Σ 0..1 dateTime When no longer valid to use quantity Σ 0..1 SimpleQuantity Amount of substance in the package ingredient Σ 0..* BackboneElement Composition information about the substance
quantity Σ 0..1 Ratio Optional amount (concentration) substance[x] Σ 1..1 A component of the substance
Substance Code (Example) substanceCodeableConcept CodeableConcept substanceReference Reference(Substance)
Documentation for this format
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Base.Entities"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 2
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "business"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "oo"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/Substance",
"version" : "4.0.1",
"name" : "Substance",
"status" : "draft",
"date" : "2019-11-01T09:29:23+11:00",
"publisher" : "Health Level Seven International (Orders and Observations)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/orders/index.cfm"
}]
}],
"description" : "A homogeneous material with a definite composition.",
"fhirVersion" : "4.0.1",
"mapping" : [{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
},
{
"identity" : "orim",
"uri" : "http://hl7.org/orim",
"name" : "Ontological RIM Mapping"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/fivews",
"name" : "FiveWs Pattern Mapping"
}],
"kind" : "resource",
"abstract" : false,
"type" : "Substance",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "Substance",
"path" : "Substance",
"short" : "A homogeneous material with a definite composition",
"definition" : "A homogeneous material with a definite composition.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Substance",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "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",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.`div`.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "rim",
"map" : "Material"
},
{
"identity" : "orim",
"map" : "fhir:Substance rdfs:subClassOf rim:Entity, [ a owl:Restriction; owl:onProperty rim:Act.classCode; owl:allValuesFrom cs:EntityClass\\#MAT ]."
}]
},
{
"id" : "Substance.id",
"path" : "Substance.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Substance.meta",
"path" : "Substance.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Substance.implicitRules",
"path" : "Substance.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "Substance.language",
"path" : "Substance.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "Substance.text",
"path" : "Substance.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "Substance.contained",
"path" : "Substance.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Substance.extension",
"path" : "Substance.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Substance.modifierExtension",
"path" : "Substance.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Substance.identifier",
"path" : "Substance.identifier",
"short" : "Unique identifier",
"definition" : "Unique identifier for the substance.",
"comment" : "This identifier is associated with the kind of substance in contrast to the Substance.instance.identifier which is associated with the package/container.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Substance.identifier",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Identifier"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "rim",
"map" : ".id"
}]
},
{
"id" : "Substance.status",
"path" : "Substance.status",
"short" : "active | inactive | entered-in-error",
"definition" : "A code to indicate if the substance is actively used.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Substance.status",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "FHIRSubstanceStatus"
}],
"strength" : "required",
"description" : "A code to indicate if the substance is actively used.",
"valueSet" : "http://hl7.org/fhir/ValueSet/substance-status|4.0.1"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.status"
},
{
"identity" : "rim",
"map" : ".statusCode"
}]
},
{
"id" : "Substance.category",
"path" : "Substance.category",
"short" : "What class/type of substance this is",
"definition" : "A code that classifies the general type of substance. This is used for searching, sorting and display purposes.",
"comment" : "The level of granularity is defined by the category concepts in the value set. More fine-grained filtering can be performed using the metadata and/or terminology hierarchy in Substance.code.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Substance.category",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SubstanceCategory"
}],
"strength" : "extensible",
"description" : "Category or classification of substance.",
"valueSet" : "http://hl7.org/fhir/ValueSet/substance-category"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.class"
},
{
"identity" : "rim",
"map" : ".code"
}]
},
{
"id" : "Substance.code",
"path" : "Substance.code",
"short" : "What substance this is",
"definition" : "A code (or set of codes) that identify this substance.",
"comment" : "This could be a reference to an externally defined code. It could also be a locally assigned code (e.g. a formulary), optionally with translations to the standard drug codes.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Substance.code",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SubstanceCode"
}],
"strength" : "example",
"description" : "Substance codes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/substance-code"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.what[x]"
},
{
"identity" : "rim",
"map" : ".code"
},
{
"identity" : "orim",
"map" : "fhir:Substance.code rdfs:subPropertyOf rim:Entity.code"
}]
},
{
"id" : "Substance.description",
"path" : "Substance.description",
"short" : "Textual description of the substance, comments",
"definition" : "A description of the substance - its appearance, handling requirements, and other usage notes.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Substance.description",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : ".player.desc"
}]
},
{
"id" : "Substance.instance",
"path" : "Substance.instance",
"short" : "If this describes a specific package/container of the substance",
"definition" : "Substance may be used to describe a kind of substance, or a specific package/container of the substance: an instance.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Substance.instance",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"meaningWhenMissing" : "If this element is not present, then the substance resource describes a kind of substance",
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : ".player.determinerCode"
}]
},
{
"id" : "Substance.instance.id",
"path" : "Substance.instance.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Substance.instance.extension",
"path" : "Substance.instance.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Substance.instance.modifierExtension",
"path" : "Substance.instance.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Substance.instance.identifier",
"path" : "Substance.instance.identifier",
"short" : "Identifier of the package/container",
"definition" : "Identifier associated with the package/container (usually a label affixed directly).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Substance.instance.identifier",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Identifier"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : ".id"
}]
},
{
"id" : "Substance.instance.expiry",
"path" : "Substance.instance.expiry",
"short" : "When no longer valid to use",
"definition" : "When the substance is no longer valid to use. For some substances, a single arbitrary date is used for expiry.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Substance.instance.expiry",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : ".expiryTime"
}]
},
{
"id" : "Substance.instance.quantity",
"path" : "Substance.instance.quantity",
"short" : "Amount of substance in the package",
"definition" : "The amount of the substance.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Substance.instance.quantity",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Quantity",
"profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : ".player.quantity"
}]
},
{
"id" : "Substance.ingredient",
"path" : "Substance.ingredient",
"short" : "Composition information about the substance",
"definition" : "A substance can be composed of other substances.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Substance.ingredient",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : ".player.scopesRole[classCode=INGR]"
}]
},
{
"id" : "Substance.ingredient.id",
"path" : "Substance.ingredient.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Substance.ingredient.extension",
"path" : "Substance.ingredient.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Substance.ingredient.modifierExtension",
"path" : "Substance.ingredient.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Substance.ingredient.quantity",
"path" : "Substance.ingredient.quantity",
"short" : "Optional amount (concentration)",
"definition" : "The amount of the ingredient in the substance - a concentration ratio.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Substance.ingredient.quantity",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Ratio"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : ".quantity"
}]
},
{
"id" : "Substance.ingredient.substance[x]",
"path" : "Substance.ingredient.substance[x]",
"short" : "A component of the substance",
"definition" : "Another substance that is a component of this substance.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Substance.ingredient.substance[x]",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
},
{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Substance"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SubstanceIngredient"
}],
"strength" : "example",
"description" : "Substance Ingredient codes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/substance-code"
},
"mapping" : [{
"identity" : "rim",
"map" : ".player"
}]
}]
},
"differential" : {
"element" : [{
"id" : "Substance",
"path" : "Substance",
"short" : "A homogeneous material with a definite composition",
"definition" : "A homogeneous material with a definite composition.",
"min" : 0,
"max" : "*",
"mapping" : [{
"identity" : "rim",
"map" : "Material"
},
{
"identity" : "orim",
"map" : "fhir:Substance rdfs:subClassOf rim:Entity, [ a owl:Restriction; owl:onProperty rim:Act.classCode; owl:allValuesFrom cs:EntityClass\\#MAT ]."
}]
},
{
"id" : "Substance.identifier",
"path" : "Substance.identifier",
"short" : "Unique identifier",
"definition" : "Unique identifier for the substance.",
"comment" : "This identifier is associated with the kind of substance in contrast to the Substance.instance.identifier which is associated with the package/container.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Identifier"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "rim",
"map" : ".id"
}]
},
{
"id" : "Substance.status",
"path" : "Substance.status",
"short" : "active | inactive | entered-in-error",
"definition" : "A code to indicate if the substance is actively used.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isModifier" : true,
"isModifierReason" : "This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "FHIRSubstanceStatus"
}],
"strength" : "required",
"description" : "A code to indicate if the substance is actively used.",
"valueSet" : "http://hl7.org/fhir/ValueSet/substance-status|4.0.1"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.status"
},
{
"identity" : "rim",
"map" : ".statusCode"
}]
},
{
"id" : "Substance.category",
"path" : "Substance.category",
"short" : "What class/type of substance this is",
"definition" : "A code that classifies the general type of substance. This is used for searching, sorting and display purposes.",
"comment" : "The level of granularity is defined by the category concepts in the value set. More fine-grained filtering can be performed using the metadata and/or terminology hierarchy in Substance.code.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SubstanceCategory"
}],
"strength" : "extensible",
"description" : "Category or classification of substance.",
"valueSet" : "http://hl7.org/fhir/ValueSet/substance-category"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.class"
},
{
"identity" : "rim",
"map" : ".code"
}]
},
{
"id" : "Substance.code",
"path" : "Substance.code",
"short" : "What substance this is",
"definition" : "A code (or set of codes) that identify this substance.",
"comment" : "This could be a reference to an externally defined code. It could also be a locally assigned code (e.g. a formulary), optionally with translations to the standard drug codes.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SubstanceCode"
}],
"strength" : "example",
"description" : "Substance codes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/substance-code"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.what[x]"
},
{
"identity" : "rim",
"map" : ".code"
},
{
"identity" : "orim",
"map" : "fhir:Substance.code rdfs:subPropertyOf rim:Entity.code"
}]
},
{
"id" : "Substance.description",
"path" : "Substance.description",
"short" : "Textual description of the substance, comments",
"definition" : "A description of the substance - its appearance, handling requirements, and other usage notes.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : ".player.desc"
}]
},
{
"id" : "Substance.instance",
"path" : "Substance.instance",
"short" : "If this describes a specific package/container of the substance",
"definition" : "Substance may be used to describe a kind of substance, or a specific package/container of the substance: an instance.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"meaningWhenMissing" : "If this element is not present, then the substance resource describes a kind of substance",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : ".player.determinerCode"
}]
},
{
"id" : "Substance.instance.identifier",
"path" : "Substance.instance.identifier",
"short" : "Identifier of the package/container",
"definition" : "Identifier associated with the package/container (usually a label affixed directly).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Identifier"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : ".id"
}]
},
{
"id" : "Substance.instance.expiry",
"path" : "Substance.instance.expiry",
"short" : "When no longer valid to use",
"definition" : "When the substance is no longer valid to use. For some substances, a single arbitrary date is used for expiry.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "dateTime"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : ".expiryTime"
}]
},
{
"id" : "Substance.instance.quantity",
"path" : "Substance.instance.quantity",
"short" : "Amount of substance in the package",
"definition" : "The amount of the substance.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Quantity",
"profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : ".player.quantity"
}]
},
{
"id" : "Substance.ingredient",
"path" : "Substance.ingredient",
"short" : "Composition information about the substance",
"definition" : "A substance can be composed of other substances.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : ".player.scopesRole[classCode=INGR]"
}]
},
{
"id" : "Substance.ingredient.quantity",
"path" : "Substance.ingredient.quantity",
"short" : "Optional amount (concentration)",
"definition" : "The amount of the ingredient in the substance - a concentration ratio.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Ratio"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : ".quantity"
}]
},
{
"id" : "Substance.ingredient.substance[x]",
"path" : "Substance.ingredient.substance[x]",
"short" : "A component of the substance",
"definition" : "Another substance that is a component of this substance.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
},
{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Substance"]
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SubstanceIngredient"
}],
"strength" : "example",
"description" : "Substance Ingredient codes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/substance-code"
},
"mapping" : [{
"identity" : "rim",
"map" : ".player"
}]
}]
}
}
},
{
"fullUrl" : "http://hl7.org/fhir/StructureDefinition/SubstanceNucleicAcid",
"resource" : {
"resourceType" : "StructureDefinition",
"id" : "SubstanceNucleicAcid",
"meta" : {
"lastUpdated" : "2019-11-01T09:29:23.356+11:00"
},
"text" : {
"status" : "generated",
"div" : "Name Flags Card. Type Description & Constraints SubstanceNucleicAcid Σ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 sequenceType Σ 0..1 CodeableConcept The type of the sequence shall be specified based on a controlled vocabulary numberOfSubunits Σ 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 areaOfHybridisation Σ 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” oligoNucleotideType Σ 0..1 CodeableConcept (TBC) subunit Σ 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
subunit Σ 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 sequence Σ 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 length Σ 0..1 integer The length of the sequence shall be captured sequenceAttachment Σ 0..1 Attachment (TBC) fivePrime Σ 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 threePrime Σ 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 linkage Σ 0..* BackboneElement The linkages between sugar residues will also be captured
connectivity Σ 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 identifier Σ 0..1 Identifier Each linkage will be registered as a fragment and have an ID name Σ 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 residueSite Σ 0..1 string Residues shall be captured as described in 5.3.6.8.3 sugar Σ 0..* BackboneElement 5.3.6.8.1 Sugar ID (Mandatory)
identifier Σ 0..1 Identifier The Substance ID of the sugar or sugar-like component that make up the nucleotide name Σ 0..1 string The name of the sugar or sugar-like component that make up the nucleotide residueSite Σ 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
Documentation for this format
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Specialized.Medication Definition"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 0
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "anonymous"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "brr"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/SubstanceNucleicAcid",
"version" : "4.0.1",
"name" : "SubstanceNucleicAcid",
"status" : "draft",
"date" : "2019-11-01T09:29:23+11:00",
"publisher" : "Health Level Seven International (Biomedical Research and Regulation)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/rcrim/index.cfm"
}]
}],
"description" : "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.",
"fhirVersion" : "4.0.1",
"mapping" : [{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
}],
"kind" : "resource",
"abstract" : false,
"type" : "SubstanceNucleicAcid",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "SubstanceNucleicAcid",
"path" : "SubstanceNucleicAcid",
"short" : "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",
"definition" : "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.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SubstanceNucleicAcid",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "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",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.`div`.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
}]
},
{
"id" : "SubstanceNucleicAcid.id",
"path" : "SubstanceNucleicAcid.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceNucleicAcid.meta",
"path" : "SubstanceNucleicAcid.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceNucleicAcid.implicitRules",
"path" : "SubstanceNucleicAcid.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "SubstanceNucleicAcid.language",
"path" : "SubstanceNucleicAcid.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "SubstanceNucleicAcid.text",
"path" : "SubstanceNucleicAcid.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "SubstanceNucleicAcid.contained",
"path" : "SubstanceNucleicAcid.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "SubstanceNucleicAcid.extension",
"path" : "SubstanceNucleicAcid.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "SubstanceNucleicAcid.modifierExtension",
"path" : "SubstanceNucleicAcid.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "SubstanceNucleicAcid.sequenceType",
"path" : "SubstanceNucleicAcid.sequenceType",
"short" : "The type of the sequence shall be specified based on a controlled vocabulary",
"definition" : "The type of the sequence shall be specified based on a controlled vocabulary.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceNucleicAcid.sequenceType",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceNucleicAcid.numberOfSubunits",
"path" : "SubstanceNucleicAcid.numberOfSubunits",
"short" : "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",
"definition" : "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.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceNucleicAcid.numberOfSubunits",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "integer"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceNucleicAcid.areaOfHybridisation",
"path" : "SubstanceNucleicAcid.areaOfHybridisation",
"short" : "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”",
"definition" : "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”.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceNucleicAcid.areaOfHybridisation",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceNucleicAcid.oligoNucleotideType",
"path" : "SubstanceNucleicAcid.oligoNucleotideType",
"short" : "(TBC)",
"definition" : "(TBC).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceNucleicAcid.oligoNucleotideType",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceNucleicAcid.subunit",
"path" : "SubstanceNucleicAcid.subunit",
"short" : "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",
"definition" : "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.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SubstanceNucleicAcid.subunit",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceNucleicAcid.subunit.id",
"path" : "SubstanceNucleicAcid.subunit.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "SubstanceNucleicAcid.subunit.extension",
"path" : "SubstanceNucleicAcid.subunit.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "SubstanceNucleicAcid.subunit.modifierExtension",
"path" : "SubstanceNucleicAcid.subunit.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "SubstanceNucleicAcid.subunit.subunit",
"path" : "SubstanceNucleicAcid.subunit.subunit",
"short" : "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",
"definition" : "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.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceNucleicAcid.subunit.subunit",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "integer"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceNucleicAcid.subunit.sequence",
"path" : "SubstanceNucleicAcid.subunit.sequence",
"short" : "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",
"definition" : "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.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceNucleicAcid.subunit.sequence",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceNucleicAcid.subunit.length",
"path" : "SubstanceNucleicAcid.subunit.length",
"short" : "The length of the sequence shall be captured",
"definition" : "The length of the sequence shall be captured.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceNucleicAcid.subunit.length",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "integer"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceNucleicAcid.subunit.sequenceAttachment",
"path" : "SubstanceNucleicAcid.subunit.sequenceAttachment",
"short" : "(TBC)",
"definition" : "(TBC).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceNucleicAcid.subunit.sequenceAttachment",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Attachment"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceNucleicAcid.subunit.fivePrime",
"path" : "SubstanceNucleicAcid.subunit.fivePrime",
"short" : "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",
"definition" : "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.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceNucleicAcid.subunit.fivePrime",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceNucleicAcid.subunit.threePrime",
"path" : "SubstanceNucleicAcid.subunit.threePrime",
"short" : "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",
"definition" : "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.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceNucleicAcid.subunit.threePrime",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceNucleicAcid.subunit.linkage",
"path" : "SubstanceNucleicAcid.subunit.linkage",
"short" : "The linkages between sugar residues will also be captured",
"definition" : "The linkages between sugar residues will also be captured.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SubstanceNucleicAcid.subunit.linkage",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceNucleicAcid.subunit.linkage.id",
"path" : "SubstanceNucleicAcid.subunit.linkage.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "SubstanceNucleicAcid.subunit.linkage.extension",
"path" : "SubstanceNucleicAcid.subunit.linkage.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "SubstanceNucleicAcid.subunit.linkage.modifierExtension",
"path" : "SubstanceNucleicAcid.subunit.linkage.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "SubstanceNucleicAcid.subunit.linkage.connectivity",
"path" : "SubstanceNucleicAcid.subunit.linkage.connectivity",
"short" : "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",
"definition" : "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.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceNucleicAcid.subunit.linkage.connectivity",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceNucleicAcid.subunit.linkage.identifier",
"path" : "SubstanceNucleicAcid.subunit.linkage.identifier",
"short" : "Each linkage will be registered as a fragment and have an ID",
"definition" : "Each linkage will be registered as a fragment and have an ID.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceNucleicAcid.subunit.linkage.identifier",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Identifier"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceNucleicAcid.subunit.linkage.name",
"path" : "SubstanceNucleicAcid.subunit.linkage.name",
"short" : "Each linkage will be registered as a fragment and have at least one name. A single name shall be assigned to each linkage",
"definition" : "Each linkage will be registered as a fragment and have at least one name. A single name shall be assigned to each linkage.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceNucleicAcid.subunit.linkage.name",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceNucleicAcid.subunit.linkage.residueSite",
"path" : "SubstanceNucleicAcid.subunit.linkage.residueSite",
"short" : "Residues shall be captured as described in 5.3.6.8.3",
"definition" : "Residues shall be captured as described in 5.3.6.8.3.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceNucleicAcid.subunit.linkage.residueSite",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceNucleicAcid.subunit.sugar",
"path" : "SubstanceNucleicAcid.subunit.sugar",
"short" : "5.3.6.8.1 Sugar ID (Mandatory)",
"definition" : "5.3.6.8.1 Sugar ID (Mandatory).",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SubstanceNucleicAcid.subunit.sugar",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceNucleicAcid.subunit.sugar.id",
"path" : "SubstanceNucleicAcid.subunit.sugar.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "SubstanceNucleicAcid.subunit.sugar.extension",
"path" : "SubstanceNucleicAcid.subunit.sugar.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "SubstanceNucleicAcid.subunit.sugar.modifierExtension",
"path" : "SubstanceNucleicAcid.subunit.sugar.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "SubstanceNucleicAcid.subunit.sugar.identifier",
"path" : "SubstanceNucleicAcid.subunit.sugar.identifier",
"short" : "The Substance ID of the sugar or sugar-like component that make up the nucleotide",
"definition" : "The Substance ID of the sugar or sugar-like component that make up the nucleotide.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceNucleicAcid.subunit.sugar.identifier",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Identifier"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceNucleicAcid.subunit.sugar.name",
"path" : "SubstanceNucleicAcid.subunit.sugar.name",
"short" : "The name of the sugar or sugar-like component that make up the nucleotide",
"definition" : "The name of the sugar or sugar-like component that make up the nucleotide.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceNucleicAcid.subunit.sugar.name",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceNucleicAcid.subunit.sugar.residueSite",
"path" : "SubstanceNucleicAcid.subunit.sugar.residueSite",
"short" : "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",
"definition" : "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.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceNucleicAcid.subunit.sugar.residueSite",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
}]
},
"differential" : {
"element" : [{
"id" : "SubstanceNucleicAcid",
"path" : "SubstanceNucleicAcid",
"short" : "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",
"definition" : "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.",
"min" : 0,
"max" : "*"
},
{
"id" : "SubstanceNucleicAcid.sequenceType",
"path" : "SubstanceNucleicAcid.sequenceType",
"short" : "The type of the sequence shall be specified based on a controlled vocabulary",
"definition" : "The type of the sequence shall be specified based on a controlled vocabulary.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "SubstanceNucleicAcid.numberOfSubunits",
"path" : "SubstanceNucleicAcid.numberOfSubunits",
"short" : "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",
"definition" : "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.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "integer"
}],
"isSummary" : true
},
{
"id" : "SubstanceNucleicAcid.areaOfHybridisation",
"path" : "SubstanceNucleicAcid.areaOfHybridisation",
"short" : "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”",
"definition" : "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”.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "SubstanceNucleicAcid.oligoNucleotideType",
"path" : "SubstanceNucleicAcid.oligoNucleotideType",
"short" : "(TBC)",
"definition" : "(TBC).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "SubstanceNucleicAcid.subunit",
"path" : "SubstanceNucleicAcid.subunit",
"short" : "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",
"definition" : "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.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"isSummary" : true
},
{
"id" : "SubstanceNucleicAcid.subunit.subunit",
"path" : "SubstanceNucleicAcid.subunit.subunit",
"short" : "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",
"definition" : "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.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "integer"
}],
"isSummary" : true
},
{
"id" : "SubstanceNucleicAcid.subunit.sequence",
"path" : "SubstanceNucleicAcid.subunit.sequence",
"short" : "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",
"definition" : "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.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "SubstanceNucleicAcid.subunit.length",
"path" : "SubstanceNucleicAcid.subunit.length",
"short" : "The length of the sequence shall be captured",
"definition" : "The length of the sequence shall be captured.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "integer"
}],
"isSummary" : true
},
{
"id" : "SubstanceNucleicAcid.subunit.sequenceAttachment",
"path" : "SubstanceNucleicAcid.subunit.sequenceAttachment",
"short" : "(TBC)",
"definition" : "(TBC).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Attachment"
}],
"isSummary" : true
},
{
"id" : "SubstanceNucleicAcid.subunit.fivePrime",
"path" : "SubstanceNucleicAcid.subunit.fivePrime",
"short" : "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",
"definition" : "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.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "SubstanceNucleicAcid.subunit.threePrime",
"path" : "SubstanceNucleicAcid.subunit.threePrime",
"short" : "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",
"definition" : "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.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "SubstanceNucleicAcid.subunit.linkage",
"path" : "SubstanceNucleicAcid.subunit.linkage",
"short" : "The linkages between sugar residues will also be captured",
"definition" : "The linkages between sugar residues will also be captured.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"isSummary" : true
},
{
"id" : "SubstanceNucleicAcid.subunit.linkage.connectivity",
"path" : "SubstanceNucleicAcid.subunit.linkage.connectivity",
"short" : "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",
"definition" : "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.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "SubstanceNucleicAcid.subunit.linkage.identifier",
"path" : "SubstanceNucleicAcid.subunit.linkage.identifier",
"short" : "Each linkage will be registered as a fragment and have an ID",
"definition" : "Each linkage will be registered as a fragment and have an ID.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Identifier"
}],
"isSummary" : true
},
{
"id" : "SubstanceNucleicAcid.subunit.linkage.name",
"path" : "SubstanceNucleicAcid.subunit.linkage.name",
"short" : "Each linkage will be registered as a fragment and have at least one name. A single name shall be assigned to each linkage",
"definition" : "Each linkage will be registered as a fragment and have at least one name. A single name shall be assigned to each linkage.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "SubstanceNucleicAcid.subunit.linkage.residueSite",
"path" : "SubstanceNucleicAcid.subunit.linkage.residueSite",
"short" : "Residues shall be captured as described in 5.3.6.8.3",
"definition" : "Residues shall be captured as described in 5.3.6.8.3.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "SubstanceNucleicAcid.subunit.sugar",
"path" : "SubstanceNucleicAcid.subunit.sugar",
"short" : "5.3.6.8.1 Sugar ID (Mandatory)",
"definition" : "5.3.6.8.1 Sugar ID (Mandatory).",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"isSummary" : true
},
{
"id" : "SubstanceNucleicAcid.subunit.sugar.identifier",
"path" : "SubstanceNucleicAcid.subunit.sugar.identifier",
"short" : "The Substance ID of the sugar or sugar-like component that make up the nucleotide",
"definition" : "The Substance ID of the sugar or sugar-like component that make up the nucleotide.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Identifier"
}],
"isSummary" : true
},
{
"id" : "SubstanceNucleicAcid.subunit.sugar.name",
"path" : "SubstanceNucleicAcid.subunit.sugar.name",
"short" : "The name of the sugar or sugar-like component that make up the nucleotide",
"definition" : "The name of the sugar or sugar-like component that make up the nucleotide.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "SubstanceNucleicAcid.subunit.sugar.residueSite",
"path" : "SubstanceNucleicAcid.subunit.sugar.residueSite",
"short" : "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",
"definition" : "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.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true
}]
}
}
},
{
"fullUrl" : "http://hl7.org/fhir/StructureDefinition/SubstancePolymer",
"resource" : {
"resourceType" : "StructureDefinition",
"id" : "SubstancePolymer",
"meta" : {
"lastUpdated" : "2019-11-01T09:29:23.356+11:00"
},
"text" : {
"status" : "generated",
"div" : "Name Flags Card. Type Description & Constraints SubstancePolymer ΣTU DomainResource Todo
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension class Σ 0..1 CodeableConcept Todo geometry Σ 0..1 CodeableConcept Todo copolymerConnectivity Σ 0..* CodeableConcept Todo
modification Σ 0..* string Todo
monomerSet Σ 0..* BackboneElement Todo
ratioType Σ 0..1 CodeableConcept Todo startingMaterial Σ 0..* BackboneElement Todo
material Σ 0..1 CodeableConcept Todo type Σ 0..1 CodeableConcept Todo isDefining Σ 0..1 boolean Todo amount Σ 0..1 SubstanceAmount Todo repeat Σ 0..* BackboneElement Todo
numberOfUnits Σ 0..1 integer Todo averageMolecularFormula Σ 0..1 string Todo repeatUnitAmountType Σ 0..1 CodeableConcept Todo repeatUnit Σ 0..* BackboneElement Todo
orientationOfPolymerisation Σ 0..1 CodeableConcept Todo repeatUnit Σ 0..1 string Todo amount Σ 0..1 SubstanceAmount Todo degreeOfPolymerisation Σ 0..* BackboneElement Todo
degree Σ 0..1 CodeableConcept Todo amount Σ 0..1 SubstanceAmount Todo structuralRepresentation Σ 0..* BackboneElement Todo
type Σ 0..1 CodeableConcept Todo representation Σ 0..1 string Todo attachment Σ 0..1 Attachment Todo
Documentation for this format
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Specialized.Medication Definition"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 0
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "anonymous"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "brr"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/SubstancePolymer",
"version" : "4.0.1",
"name" : "SubstancePolymer",
"status" : "draft",
"date" : "2019-11-01T09:29:23+11:00",
"publisher" : "Health Level Seven International (Biomedical Research and Regulation)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/rcrim/index.cfm"
}]
}],
"description" : "Todo.",
"fhirVersion" : "4.0.1",
"mapping" : [{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
}],
"kind" : "resource",
"abstract" : false,
"type" : "SubstancePolymer",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "SubstancePolymer",
"path" : "SubstancePolymer",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SubstancePolymer",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "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",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.`div`.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
}]
},
{
"id" : "SubstancePolymer.id",
"path" : "SubstancePolymer.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstancePolymer.meta",
"path" : "SubstancePolymer.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstancePolymer.implicitRules",
"path" : "SubstancePolymer.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "SubstancePolymer.language",
"path" : "SubstancePolymer.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "SubstancePolymer.text",
"path" : "SubstancePolymer.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "SubstancePolymer.contained",
"path" : "SubstancePolymer.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "SubstancePolymer.extension",
"path" : "SubstancePolymer.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "SubstancePolymer.modifierExtension",
"path" : "SubstancePolymer.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "SubstancePolymer.class",
"path" : "SubstancePolymer.class",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstancePolymer.class",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstancePolymer.geometry",
"path" : "SubstancePolymer.geometry",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstancePolymer.geometry",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstancePolymer.copolymerConnectivity",
"path" : "SubstancePolymer.copolymerConnectivity",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SubstancePolymer.copolymerConnectivity",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstancePolymer.modification",
"path" : "SubstancePolymer.modification",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SubstancePolymer.modification",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstancePolymer.monomerSet",
"path" : "SubstancePolymer.monomerSet",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SubstancePolymer.monomerSet",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstancePolymer.monomerSet.id",
"path" : "SubstancePolymer.monomerSet.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "SubstancePolymer.monomerSet.extension",
"path" : "SubstancePolymer.monomerSet.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "SubstancePolymer.monomerSet.modifierExtension",
"path" : "SubstancePolymer.monomerSet.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "SubstancePolymer.monomerSet.ratioType",
"path" : "SubstancePolymer.monomerSet.ratioType",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstancePolymer.monomerSet.ratioType",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstancePolymer.monomerSet.startingMaterial",
"path" : "SubstancePolymer.monomerSet.startingMaterial",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SubstancePolymer.monomerSet.startingMaterial",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstancePolymer.monomerSet.startingMaterial.id",
"path" : "SubstancePolymer.monomerSet.startingMaterial.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "SubstancePolymer.monomerSet.startingMaterial.extension",
"path" : "SubstancePolymer.monomerSet.startingMaterial.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "SubstancePolymer.monomerSet.startingMaterial.modifierExtension",
"path" : "SubstancePolymer.monomerSet.startingMaterial.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "SubstancePolymer.monomerSet.startingMaterial.material",
"path" : "SubstancePolymer.monomerSet.startingMaterial.material",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstancePolymer.monomerSet.startingMaterial.material",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstancePolymer.monomerSet.startingMaterial.type",
"path" : "SubstancePolymer.monomerSet.startingMaterial.type",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstancePolymer.monomerSet.startingMaterial.type",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstancePolymer.monomerSet.startingMaterial.isDefining",
"path" : "SubstancePolymer.monomerSet.startingMaterial.isDefining",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstancePolymer.monomerSet.startingMaterial.isDefining",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstancePolymer.monomerSet.startingMaterial.amount",
"path" : "SubstancePolymer.monomerSet.startingMaterial.amount",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstancePolymer.monomerSet.startingMaterial.amount",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "SubstanceAmount"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstancePolymer.repeat",
"path" : "SubstancePolymer.repeat",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SubstancePolymer.repeat",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstancePolymer.repeat.id",
"path" : "SubstancePolymer.repeat.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "SubstancePolymer.repeat.extension",
"path" : "SubstancePolymer.repeat.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "SubstancePolymer.repeat.modifierExtension",
"path" : "SubstancePolymer.repeat.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "SubstancePolymer.repeat.numberOfUnits",
"path" : "SubstancePolymer.repeat.numberOfUnits",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstancePolymer.repeat.numberOfUnits",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "integer"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstancePolymer.repeat.averageMolecularFormula",
"path" : "SubstancePolymer.repeat.averageMolecularFormula",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstancePolymer.repeat.averageMolecularFormula",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstancePolymer.repeat.repeatUnitAmountType",
"path" : "SubstancePolymer.repeat.repeatUnitAmountType",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstancePolymer.repeat.repeatUnitAmountType",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstancePolymer.repeat.repeatUnit",
"path" : "SubstancePolymer.repeat.repeatUnit",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SubstancePolymer.repeat.repeatUnit",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstancePolymer.repeat.repeatUnit.id",
"path" : "SubstancePolymer.repeat.repeatUnit.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "SubstancePolymer.repeat.repeatUnit.extension",
"path" : "SubstancePolymer.repeat.repeatUnit.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "SubstancePolymer.repeat.repeatUnit.modifierExtension",
"path" : "SubstancePolymer.repeat.repeatUnit.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "SubstancePolymer.repeat.repeatUnit.orientationOfPolymerisation",
"path" : "SubstancePolymer.repeat.repeatUnit.orientationOfPolymerisation",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstancePolymer.repeat.repeatUnit.orientationOfPolymerisation",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstancePolymer.repeat.repeatUnit.repeatUnit",
"path" : "SubstancePolymer.repeat.repeatUnit.repeatUnit",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstancePolymer.repeat.repeatUnit.repeatUnit",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstancePolymer.repeat.repeatUnit.amount",
"path" : "SubstancePolymer.repeat.repeatUnit.amount",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstancePolymer.repeat.repeatUnit.amount",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "SubstanceAmount"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstancePolymer.repeat.repeatUnit.degreeOfPolymerisation",
"path" : "SubstancePolymer.repeat.repeatUnit.degreeOfPolymerisation",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SubstancePolymer.repeat.repeatUnit.degreeOfPolymerisation",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstancePolymer.repeat.repeatUnit.degreeOfPolymerisation.id",
"path" : "SubstancePolymer.repeat.repeatUnit.degreeOfPolymerisation.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "SubstancePolymer.repeat.repeatUnit.degreeOfPolymerisation.extension",
"path" : "SubstancePolymer.repeat.repeatUnit.degreeOfPolymerisation.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "SubstancePolymer.repeat.repeatUnit.degreeOfPolymerisation.modifierExtension",
"path" : "SubstancePolymer.repeat.repeatUnit.degreeOfPolymerisation.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "SubstancePolymer.repeat.repeatUnit.degreeOfPolymerisation.degree",
"path" : "SubstancePolymer.repeat.repeatUnit.degreeOfPolymerisation.degree",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstancePolymer.repeat.repeatUnit.degreeOfPolymerisation.degree",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstancePolymer.repeat.repeatUnit.degreeOfPolymerisation.amount",
"path" : "SubstancePolymer.repeat.repeatUnit.degreeOfPolymerisation.amount",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstancePolymer.repeat.repeatUnit.degreeOfPolymerisation.amount",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "SubstanceAmount"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstancePolymer.repeat.repeatUnit.structuralRepresentation",
"path" : "SubstancePolymer.repeat.repeatUnit.structuralRepresentation",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SubstancePolymer.repeat.repeatUnit.structuralRepresentation",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstancePolymer.repeat.repeatUnit.structuralRepresentation.id",
"path" : "SubstancePolymer.repeat.repeatUnit.structuralRepresentation.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "SubstancePolymer.repeat.repeatUnit.structuralRepresentation.extension",
"path" : "SubstancePolymer.repeat.repeatUnit.structuralRepresentation.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "SubstancePolymer.repeat.repeatUnit.structuralRepresentation.modifierExtension",
"path" : "SubstancePolymer.repeat.repeatUnit.structuralRepresentation.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "SubstancePolymer.repeat.repeatUnit.structuralRepresentation.type",
"path" : "SubstancePolymer.repeat.repeatUnit.structuralRepresentation.type",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstancePolymer.repeat.repeatUnit.structuralRepresentation.type",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstancePolymer.repeat.repeatUnit.structuralRepresentation.representation",
"path" : "SubstancePolymer.repeat.repeatUnit.structuralRepresentation.representation",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstancePolymer.repeat.repeatUnit.structuralRepresentation.representation",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstancePolymer.repeat.repeatUnit.structuralRepresentation.attachment",
"path" : "SubstancePolymer.repeat.repeatUnit.structuralRepresentation.attachment",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstancePolymer.repeat.repeatUnit.structuralRepresentation.attachment",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Attachment"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
}]
},
"differential" : {
"element" : [{
"id" : "SubstancePolymer",
"path" : "SubstancePolymer",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "*"
},
{
"id" : "SubstancePolymer.class",
"path" : "SubstancePolymer.class",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "SubstancePolymer.geometry",
"path" : "SubstancePolymer.geometry",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "SubstancePolymer.copolymerConnectivity",
"path" : "SubstancePolymer.copolymerConnectivity",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "SubstancePolymer.modification",
"path" : "SubstancePolymer.modification",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "SubstancePolymer.monomerSet",
"path" : "SubstancePolymer.monomerSet",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"isSummary" : true
},
{
"id" : "SubstancePolymer.monomerSet.ratioType",
"path" : "SubstancePolymer.monomerSet.ratioType",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "SubstancePolymer.monomerSet.startingMaterial",
"path" : "SubstancePolymer.monomerSet.startingMaterial",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"isSummary" : true
},
{
"id" : "SubstancePolymer.monomerSet.startingMaterial.material",
"path" : "SubstancePolymer.monomerSet.startingMaterial.material",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "SubstancePolymer.monomerSet.startingMaterial.type",
"path" : "SubstancePolymer.monomerSet.startingMaterial.type",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "SubstancePolymer.monomerSet.startingMaterial.isDefining",
"path" : "SubstancePolymer.monomerSet.startingMaterial.isDefining",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "boolean"
}],
"isSummary" : true
},
{
"id" : "SubstancePolymer.monomerSet.startingMaterial.amount",
"path" : "SubstancePolymer.monomerSet.startingMaterial.amount",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "SubstanceAmount"
}],
"isSummary" : true
},
{
"id" : "SubstancePolymer.repeat",
"path" : "SubstancePolymer.repeat",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"isSummary" : true
},
{
"id" : "SubstancePolymer.repeat.numberOfUnits",
"path" : "SubstancePolymer.repeat.numberOfUnits",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "integer"
}],
"isSummary" : true
},
{
"id" : "SubstancePolymer.repeat.averageMolecularFormula",
"path" : "SubstancePolymer.repeat.averageMolecularFormula",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "SubstancePolymer.repeat.repeatUnitAmountType",
"path" : "SubstancePolymer.repeat.repeatUnitAmountType",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "SubstancePolymer.repeat.repeatUnit",
"path" : "SubstancePolymer.repeat.repeatUnit",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"isSummary" : true
},
{
"id" : "SubstancePolymer.repeat.repeatUnit.orientationOfPolymerisation",
"path" : "SubstancePolymer.repeat.repeatUnit.orientationOfPolymerisation",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "SubstancePolymer.repeat.repeatUnit.repeatUnit",
"path" : "SubstancePolymer.repeat.repeatUnit.repeatUnit",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "SubstancePolymer.repeat.repeatUnit.amount",
"path" : "SubstancePolymer.repeat.repeatUnit.amount",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "SubstanceAmount"
}],
"isSummary" : true
},
{
"id" : "SubstancePolymer.repeat.repeatUnit.degreeOfPolymerisation",
"path" : "SubstancePolymer.repeat.repeatUnit.degreeOfPolymerisation",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"isSummary" : true
},
{
"id" : "SubstancePolymer.repeat.repeatUnit.degreeOfPolymerisation.degree",
"path" : "SubstancePolymer.repeat.repeatUnit.degreeOfPolymerisation.degree",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "SubstancePolymer.repeat.repeatUnit.degreeOfPolymerisation.amount",
"path" : "SubstancePolymer.repeat.repeatUnit.degreeOfPolymerisation.amount",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "SubstanceAmount"
}],
"isSummary" : true
},
{
"id" : "SubstancePolymer.repeat.repeatUnit.structuralRepresentation",
"path" : "SubstancePolymer.repeat.repeatUnit.structuralRepresentation",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"isSummary" : true
},
{
"id" : "SubstancePolymer.repeat.repeatUnit.structuralRepresentation.type",
"path" : "SubstancePolymer.repeat.repeatUnit.structuralRepresentation.type",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "SubstancePolymer.repeat.repeatUnit.structuralRepresentation.representation",
"path" : "SubstancePolymer.repeat.repeatUnit.structuralRepresentation.representation",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "SubstancePolymer.repeat.repeatUnit.structuralRepresentation.attachment",
"path" : "SubstancePolymer.repeat.repeatUnit.structuralRepresentation.attachment",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Attachment"
}],
"isSummary" : true
}]
}
}
},
{
"fullUrl" : "http://hl7.org/fhir/StructureDefinition/SubstanceProtein",
"resource" : {
"resourceType" : "StructureDefinition",
"id" : "SubstanceProtein",
"meta" : {
"lastUpdated" : "2019-11-01T09:29:23.356+11:00"
},
"text" : {
"status" : "generated",
"div" : "Name Flags Card. Type Description & Constraints SubstanceProtein Σ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 sequenceType Σ 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 numberOfSubunits Σ 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 disulfideLinkage Σ 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
subunit Σ 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
subunit Σ 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 sequence Σ 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 length Σ 0..1 integer Length of linear sequences of amino acids contained in the subunit sequenceAttachment Σ 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 nTerminalModificationId Σ 0..1 Identifier Unique identifier for molecular fragment modification based on the ISO 11238 Substance ID nTerminalModification Σ 0..1 string The name of the fragment modified at the N-terminal of the SubstanceProtein shall be specified cTerminalModificationId Σ 0..1 Identifier Unique identifier for molecular fragment modification based on the ISO 11238 Substance ID cTerminalModification Σ 0..1 string The modification at the C-terminal shall be specified
Documentation for this format
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Specialized.Medication Definition"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 0
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "anonymous"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "brr"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/SubstanceProtein",
"version" : "4.0.1",
"name" : "SubstanceProtein",
"status" : "draft",
"date" : "2019-11-01T09:29:23+11:00",
"publisher" : "Health Level Seven International (Biomedical Research and Regulation)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/rcrim/index.cfm"
}]
}],
"description" : "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.",
"fhirVersion" : "4.0.1",
"mapping" : [{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
}],
"kind" : "resource",
"abstract" : false,
"type" : "SubstanceProtein",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "SubstanceProtein",
"path" : "SubstanceProtein",
"short" : "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",
"definition" : "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.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SubstanceProtein",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "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",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.`div`.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
}]
},
{
"id" : "SubstanceProtein.id",
"path" : "SubstanceProtein.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceProtein.meta",
"path" : "SubstanceProtein.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceProtein.implicitRules",
"path" : "SubstanceProtein.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "SubstanceProtein.language",
"path" : "SubstanceProtein.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "SubstanceProtein.text",
"path" : "SubstanceProtein.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "SubstanceProtein.contained",
"path" : "SubstanceProtein.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "SubstanceProtein.extension",
"path" : "SubstanceProtein.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "SubstanceProtein.modifierExtension",
"path" : "SubstanceProtein.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "SubstanceProtein.sequenceType",
"path" : "SubstanceProtein.sequenceType",
"short" : "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",
"definition" : "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.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceProtein.sequenceType",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceProtein.numberOfSubunits",
"path" : "SubstanceProtein.numberOfSubunits",
"short" : "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",
"definition" : "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.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceProtein.numberOfSubunits",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "integer"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceProtein.disulfideLinkage",
"path" : "SubstanceProtein.disulfideLinkage",
"short" : "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",
"definition" : "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.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SubstanceProtein.disulfideLinkage",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceProtein.subunit",
"path" : "SubstanceProtein.subunit",
"short" : "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",
"definition" : "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.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SubstanceProtein.subunit",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceProtein.subunit.id",
"path" : "SubstanceProtein.subunit.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "SubstanceProtein.subunit.extension",
"path" : "SubstanceProtein.subunit.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "SubstanceProtein.subunit.modifierExtension",
"path" : "SubstanceProtein.subunit.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "SubstanceProtein.subunit.subunit",
"path" : "SubstanceProtein.subunit.subunit",
"short" : "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",
"definition" : "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.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceProtein.subunit.subunit",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "integer"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceProtein.subunit.sequence",
"path" : "SubstanceProtein.subunit.sequence",
"short" : "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",
"definition" : "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.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceProtein.subunit.sequence",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceProtein.subunit.length",
"path" : "SubstanceProtein.subunit.length",
"short" : "Length of linear sequences of amino acids contained in the subunit",
"definition" : "Length of linear sequences of amino acids contained in the subunit.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceProtein.subunit.length",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "integer"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceProtein.subunit.sequenceAttachment",
"path" : "SubstanceProtein.subunit.sequenceAttachment",
"short" : "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",
"definition" : "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.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceProtein.subunit.sequenceAttachment",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Attachment"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceProtein.subunit.nTerminalModificationId",
"path" : "SubstanceProtein.subunit.nTerminalModificationId",
"short" : "Unique identifier for molecular fragment modification based on the ISO 11238 Substance ID",
"definition" : "Unique identifier for molecular fragment modification based on the ISO 11238 Substance ID.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceProtein.subunit.nTerminalModificationId",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Identifier"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceProtein.subunit.nTerminalModification",
"path" : "SubstanceProtein.subunit.nTerminalModification",
"short" : "The name of the fragment modified at the N-terminal of the SubstanceProtein shall be specified",
"definition" : "The name of the fragment modified at the N-terminal of the SubstanceProtein shall be specified.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceProtein.subunit.nTerminalModification",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceProtein.subunit.cTerminalModificationId",
"path" : "SubstanceProtein.subunit.cTerminalModificationId",
"short" : "Unique identifier for molecular fragment modification based on the ISO 11238 Substance ID",
"definition" : "Unique identifier for molecular fragment modification based on the ISO 11238 Substance ID.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceProtein.subunit.cTerminalModificationId",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Identifier"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceProtein.subunit.cTerminalModification",
"path" : "SubstanceProtein.subunit.cTerminalModification",
"short" : "The modification at the C-terminal shall be specified",
"definition" : "The modification at the C-terminal shall be specified.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceProtein.subunit.cTerminalModification",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
}]
},
"differential" : {
"element" : [{
"id" : "SubstanceProtein",
"path" : "SubstanceProtein",
"short" : "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",
"definition" : "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.",
"min" : 0,
"max" : "*"
},
{
"id" : "SubstanceProtein.sequenceType",
"path" : "SubstanceProtein.sequenceType",
"short" : "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",
"definition" : "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.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "SubstanceProtein.numberOfSubunits",
"path" : "SubstanceProtein.numberOfSubunits",
"short" : "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",
"definition" : "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.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "integer"
}],
"isSummary" : true
},
{
"id" : "SubstanceProtein.disulfideLinkage",
"path" : "SubstanceProtein.disulfideLinkage",
"short" : "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",
"definition" : "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.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "SubstanceProtein.subunit",
"path" : "SubstanceProtein.subunit",
"short" : "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",
"definition" : "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.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"isSummary" : true
},
{
"id" : "SubstanceProtein.subunit.subunit",
"path" : "SubstanceProtein.subunit.subunit",
"short" : "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",
"definition" : "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.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "integer"
}],
"isSummary" : true
},
{
"id" : "SubstanceProtein.subunit.sequence",
"path" : "SubstanceProtein.subunit.sequence",
"short" : "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",
"definition" : "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.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "SubstanceProtein.subunit.length",
"path" : "SubstanceProtein.subunit.length",
"short" : "Length of linear sequences of amino acids contained in the subunit",
"definition" : "Length of linear sequences of amino acids contained in the subunit.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "integer"
}],
"isSummary" : true
},
{
"id" : "SubstanceProtein.subunit.sequenceAttachment",
"path" : "SubstanceProtein.subunit.sequenceAttachment",
"short" : "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",
"definition" : "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.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Attachment"
}],
"isSummary" : true
},
{
"id" : "SubstanceProtein.subunit.nTerminalModificationId",
"path" : "SubstanceProtein.subunit.nTerminalModificationId",
"short" : "Unique identifier for molecular fragment modification based on the ISO 11238 Substance ID",
"definition" : "Unique identifier for molecular fragment modification based on the ISO 11238 Substance ID.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Identifier"
}],
"isSummary" : true
},
{
"id" : "SubstanceProtein.subunit.nTerminalModification",
"path" : "SubstanceProtein.subunit.nTerminalModification",
"short" : "The name of the fragment modified at the N-terminal of the SubstanceProtein shall be specified",
"definition" : "The name of the fragment modified at the N-terminal of the SubstanceProtein shall be specified.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "SubstanceProtein.subunit.cTerminalModificationId",
"path" : "SubstanceProtein.subunit.cTerminalModificationId",
"short" : "Unique identifier for molecular fragment modification based on the ISO 11238 Substance ID",
"definition" : "Unique identifier for molecular fragment modification based on the ISO 11238 Substance ID.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Identifier"
}],
"isSummary" : true
},
{
"id" : "SubstanceProtein.subunit.cTerminalModification",
"path" : "SubstanceProtein.subunit.cTerminalModification",
"short" : "The modification at the C-terminal shall be specified",
"definition" : "The modification at the C-terminal shall be specified.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true
}]
}
}
},
{
"fullUrl" : "http://hl7.org/fhir/StructureDefinition/SubstanceReferenceInformation",
"resource" : {
"resourceType" : "StructureDefinition",
"id" : "SubstanceReferenceInformation",
"meta" : {
"lastUpdated" : "2019-11-01T09:29:23.356+11:00"
},
"text" : {
"status" : "generated",
"div" : "Name Flags Card. Type Description & Constraints SubstanceReferenceInformation ΣTU DomainResource Todo
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension comment Σ 0..1 string Todo gene Σ 0..* BackboneElement Todo
geneSequenceOrigin Σ 0..1 CodeableConcept Todo gene Σ 0..1 CodeableConcept Todo source Σ 0..* Reference(DocumentReference) Todo
geneElement Σ 0..* BackboneElement Todo
type Σ 0..1 CodeableConcept Todo element Σ 0..1 Identifier Todo source Σ 0..* Reference(DocumentReference) Todo
classification Σ 0..* BackboneElement Todo
domain Σ 0..1 CodeableConcept Todo classification Σ 0..1 CodeableConcept Todo subtype Σ 0..* CodeableConcept Todo
source Σ 0..* Reference(DocumentReference) Todo
target Σ 0..* BackboneElement Todo
target Σ 0..1 Identifier Todo type Σ 0..1 CodeableConcept Todo interaction Σ 0..1 CodeableConcept Todo organism Σ 0..1 CodeableConcept Todo organismType Σ 0..1 CodeableConcept Todo amount[x] Σ 0..1 Todo amountQuantity Quantity amountRange Range amountString string amountType Σ 0..1 CodeableConcept Todo source Σ 0..* Reference(DocumentReference) Todo
Documentation for this format
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Specialized.Medication Definition"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 0
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "anonymous"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "brr"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/SubstanceReferenceInformation",
"version" : "4.0.1",
"name" : "SubstanceReferenceInformation",
"status" : "draft",
"date" : "2019-11-01T09:29:23+11:00",
"publisher" : "Health Level Seven International (Biomedical Research and Regulation)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/rcrim/index.cfm"
}]
}],
"description" : "Todo.",
"fhirVersion" : "4.0.1",
"mapping" : [{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
}],
"kind" : "resource",
"abstract" : false,
"type" : "SubstanceReferenceInformation",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "SubstanceReferenceInformation",
"path" : "SubstanceReferenceInformation",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SubstanceReferenceInformation",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "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",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.`div`.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
}]
},
{
"id" : "SubstanceReferenceInformation.id",
"path" : "SubstanceReferenceInformation.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceReferenceInformation.meta",
"path" : "SubstanceReferenceInformation.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceReferenceInformation.implicitRules",
"path" : "SubstanceReferenceInformation.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "SubstanceReferenceInformation.language",
"path" : "SubstanceReferenceInformation.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "SubstanceReferenceInformation.text",
"path" : "SubstanceReferenceInformation.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "SubstanceReferenceInformation.contained",
"path" : "SubstanceReferenceInformation.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "SubstanceReferenceInformation.extension",
"path" : "SubstanceReferenceInformation.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "SubstanceReferenceInformation.modifierExtension",
"path" : "SubstanceReferenceInformation.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "SubstanceReferenceInformation.comment",
"path" : "SubstanceReferenceInformation.comment",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceReferenceInformation.comment",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceReferenceInformation.gene",
"path" : "SubstanceReferenceInformation.gene",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SubstanceReferenceInformation.gene",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceReferenceInformation.gene.id",
"path" : "SubstanceReferenceInformation.gene.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "SubstanceReferenceInformation.gene.extension",
"path" : "SubstanceReferenceInformation.gene.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "SubstanceReferenceInformation.gene.modifierExtension",
"path" : "SubstanceReferenceInformation.gene.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "SubstanceReferenceInformation.gene.geneSequenceOrigin",
"path" : "SubstanceReferenceInformation.gene.geneSequenceOrigin",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceReferenceInformation.gene.geneSequenceOrigin",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceReferenceInformation.gene.gene",
"path" : "SubstanceReferenceInformation.gene.gene",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceReferenceInformation.gene.gene",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceReferenceInformation.gene.source",
"path" : "SubstanceReferenceInformation.gene.source",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SubstanceReferenceInformation.gene.source",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/DocumentReference"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceReferenceInformation.geneElement",
"path" : "SubstanceReferenceInformation.geneElement",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SubstanceReferenceInformation.geneElement",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceReferenceInformation.geneElement.id",
"path" : "SubstanceReferenceInformation.geneElement.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "SubstanceReferenceInformation.geneElement.extension",
"path" : "SubstanceReferenceInformation.geneElement.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "SubstanceReferenceInformation.geneElement.modifierExtension",
"path" : "SubstanceReferenceInformation.geneElement.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "SubstanceReferenceInformation.geneElement.type",
"path" : "SubstanceReferenceInformation.geneElement.type",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceReferenceInformation.geneElement.type",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceReferenceInformation.geneElement.element",
"path" : "SubstanceReferenceInformation.geneElement.element",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceReferenceInformation.geneElement.element",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Identifier"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceReferenceInformation.geneElement.source",
"path" : "SubstanceReferenceInformation.geneElement.source",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SubstanceReferenceInformation.geneElement.source",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/DocumentReference"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceReferenceInformation.classification",
"path" : "SubstanceReferenceInformation.classification",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SubstanceReferenceInformation.classification",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceReferenceInformation.classification.id",
"path" : "SubstanceReferenceInformation.classification.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "SubstanceReferenceInformation.classification.extension",
"path" : "SubstanceReferenceInformation.classification.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "SubstanceReferenceInformation.classification.modifierExtension",
"path" : "SubstanceReferenceInformation.classification.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "SubstanceReferenceInformation.classification.domain",
"path" : "SubstanceReferenceInformation.classification.domain",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceReferenceInformation.classification.domain",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceReferenceInformation.classification.classification",
"path" : "SubstanceReferenceInformation.classification.classification",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceReferenceInformation.classification.classification",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceReferenceInformation.classification.subtype",
"path" : "SubstanceReferenceInformation.classification.subtype",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SubstanceReferenceInformation.classification.subtype",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceReferenceInformation.classification.source",
"path" : "SubstanceReferenceInformation.classification.source",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SubstanceReferenceInformation.classification.source",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/DocumentReference"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceReferenceInformation.target",
"path" : "SubstanceReferenceInformation.target",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SubstanceReferenceInformation.target",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceReferenceInformation.target.id",
"path" : "SubstanceReferenceInformation.target.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "SubstanceReferenceInformation.target.extension",
"path" : "SubstanceReferenceInformation.target.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "SubstanceReferenceInformation.target.modifierExtension",
"path" : "SubstanceReferenceInformation.target.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "SubstanceReferenceInformation.target.target",
"path" : "SubstanceReferenceInformation.target.target",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceReferenceInformation.target.target",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Identifier"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceReferenceInformation.target.type",
"path" : "SubstanceReferenceInformation.target.type",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceReferenceInformation.target.type",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceReferenceInformation.target.interaction",
"path" : "SubstanceReferenceInformation.target.interaction",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceReferenceInformation.target.interaction",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceReferenceInformation.target.organism",
"path" : "SubstanceReferenceInformation.target.organism",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceReferenceInformation.target.organism",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceReferenceInformation.target.organismType",
"path" : "SubstanceReferenceInformation.target.organismType",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceReferenceInformation.target.organismType",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceReferenceInformation.target.amount[x]",
"path" : "SubstanceReferenceInformation.target.amount[x]",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceReferenceInformation.target.amount[x]",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Quantity"
},
{
"code" : "Range"
},
{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceReferenceInformation.target.amountType",
"path" : "SubstanceReferenceInformation.target.amountType",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceReferenceInformation.target.amountType",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceReferenceInformation.target.source",
"path" : "SubstanceReferenceInformation.target.source",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SubstanceReferenceInformation.target.source",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/DocumentReference"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
}]
},
"differential" : {
"element" : [{
"id" : "SubstanceReferenceInformation",
"path" : "SubstanceReferenceInformation",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "*"
},
{
"id" : "SubstanceReferenceInformation.comment",
"path" : "SubstanceReferenceInformation.comment",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "SubstanceReferenceInformation.gene",
"path" : "SubstanceReferenceInformation.gene",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"isSummary" : true
},
{
"id" : "SubstanceReferenceInformation.gene.geneSequenceOrigin",
"path" : "SubstanceReferenceInformation.gene.geneSequenceOrigin",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "SubstanceReferenceInformation.gene.gene",
"path" : "SubstanceReferenceInformation.gene.gene",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "SubstanceReferenceInformation.gene.source",
"path" : "SubstanceReferenceInformation.gene.source",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/DocumentReference"]
}],
"isSummary" : true
},
{
"id" : "SubstanceReferenceInformation.geneElement",
"path" : "SubstanceReferenceInformation.geneElement",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"isSummary" : true
},
{
"id" : "SubstanceReferenceInformation.geneElement.type",
"path" : "SubstanceReferenceInformation.geneElement.type",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "SubstanceReferenceInformation.geneElement.element",
"path" : "SubstanceReferenceInformation.geneElement.element",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Identifier"
}],
"isSummary" : true
},
{
"id" : "SubstanceReferenceInformation.geneElement.source",
"path" : "SubstanceReferenceInformation.geneElement.source",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/DocumentReference"]
}],
"isSummary" : true
},
{
"id" : "SubstanceReferenceInformation.classification",
"path" : "SubstanceReferenceInformation.classification",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"isSummary" : true
},
{
"id" : "SubstanceReferenceInformation.classification.domain",
"path" : "SubstanceReferenceInformation.classification.domain",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "SubstanceReferenceInformation.classification.classification",
"path" : "SubstanceReferenceInformation.classification.classification",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "SubstanceReferenceInformation.classification.subtype",
"path" : "SubstanceReferenceInformation.classification.subtype",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "SubstanceReferenceInformation.classification.source",
"path" : "SubstanceReferenceInformation.classification.source",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/DocumentReference"]
}],
"isSummary" : true
},
{
"id" : "SubstanceReferenceInformation.target",
"path" : "SubstanceReferenceInformation.target",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"isSummary" : true
},
{
"id" : "SubstanceReferenceInformation.target.target",
"path" : "SubstanceReferenceInformation.target.target",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Identifier"
}],
"isSummary" : true
},
{
"id" : "SubstanceReferenceInformation.target.type",
"path" : "SubstanceReferenceInformation.target.type",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "SubstanceReferenceInformation.target.interaction",
"path" : "SubstanceReferenceInformation.target.interaction",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "SubstanceReferenceInformation.target.organism",
"path" : "SubstanceReferenceInformation.target.organism",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "SubstanceReferenceInformation.target.organismType",
"path" : "SubstanceReferenceInformation.target.organismType",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "SubstanceReferenceInformation.target.amount[x]",
"path" : "SubstanceReferenceInformation.target.amount[x]",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Quantity"
},
{
"code" : "Range"
},
{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "SubstanceReferenceInformation.target.amountType",
"path" : "SubstanceReferenceInformation.target.amountType",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "SubstanceReferenceInformation.target.source",
"path" : "SubstanceReferenceInformation.target.source",
"short" : "Todo",
"definition" : "Todo.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/DocumentReference"]
}],
"isSummary" : true
}]
}
}
},
{
"fullUrl" : "http://hl7.org/fhir/StructureDefinition/SubstanceSourceMaterial",
"resource" : {
"resourceType" : "StructureDefinition",
"id" : "SubstanceSourceMaterial",
"meta" : {
"lastUpdated" : "2019-11-01T09:29:23.356+11:00"
},
"text" : {
"status" : "generated",
"div" : "Name Flags Card. Type Description & Constraints SubstanceSourceMaterial Σ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 sourceMaterialClass Σ 0..1 CodeableConcept General high level classification of the source material specific to the origin of the material sourceMaterialType Σ 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 sourceMaterialState Σ 0..1 CodeableConcept The state of the source material when extracted organismId Σ 0..1 Identifier The unique identifier associated with the source material parent organism shall be specified organismName Σ 0..1 string The organism accepted Scientific name shall be provided based on the organism taxonomy parentSubstanceId Σ 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)
parentSubstanceName Σ 0..* string The parent substance of the Herbal Drug, or Herbal preparation
countryOfOrigin Σ 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
geographicalLocation Σ 0..* string The place/region where the plant is harvested or the places/regions where the animal source material has its habitat
developmentStage Σ 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) fractionDescription Σ 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
fraction Σ 0..1 string This element is capturing information about the fraction of a plant part, or human plasma for fractionation materialType Σ 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 organism Σ 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 family Σ 0..1 CodeableConcept The family of an organism shall be specified genus Σ 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 species Σ 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 intraspecificType Σ 0..1 CodeableConcept The Intraspecific type of an organism shall be specified intraspecificDescription Σ 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 author Σ 0..* BackboneElement 4.9.13.6.1 Author type (Conditional)
authorType Σ 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 authorDescription Σ 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) hybrid Σ 0..1 BackboneElement 4.9.13.8.1 Hybrid species maternal organism ID (Optional) maternalOrganismId Σ 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 maternalOrganismName Σ 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 paternalOrganismId Σ 0..1 string The identifier of the paternal species constituting the hybrid organism shall be specified based on a controlled vocabulary paternalOrganismName Σ 0..1 string The name of the paternal species constituting the hybrid organism shall be specified hybridType Σ 0..1 CodeableConcept The hybrid type of an organism shall be specified organismGeneral Σ 0..1 BackboneElement 4.9.13.7.1 Kingdom (Conditional) kingdom Σ 0..1 CodeableConcept The kingdom of an organism shall be specified phylum Σ 0..1 CodeableConcept The phylum of an organism shall be specified class Σ 0..1 CodeableConcept The class of an organism shall be specified order Σ 0..1 CodeableConcept The order of an organism shall be specified, partDescription Σ 0..* BackboneElement To do
part Σ 0..1 CodeableConcept Entity of anatomical origin of source material within an organism partLocation Σ 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
Documentation for this format
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Specialized.Medication Definition"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 0
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "anonymous"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "brr"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/SubstanceSourceMaterial",
"version" : "4.0.1",
"name" : "SubstanceSourceMaterial",
"status" : "draft",
"date" : "2019-11-01T09:29:23+11:00",
"publisher" : "Health Level Seven International (Biomedical Research and Regulation)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/rcrim/index.cfm"
}]
}],
"description" : "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.",
"fhirVersion" : "4.0.1",
"mapping" : [{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
}],
"kind" : "resource",
"abstract" : false,
"type" : "SubstanceSourceMaterial",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "SubstanceSourceMaterial",
"path" : "SubstanceSourceMaterial",
"short" : "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",
"definition" : "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.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SubstanceSourceMaterial",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "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",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.`div`.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
}]
},
{
"id" : "SubstanceSourceMaterial.id",
"path" : "SubstanceSourceMaterial.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSourceMaterial.meta",
"path" : "SubstanceSourceMaterial.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSourceMaterial.implicitRules",
"path" : "SubstanceSourceMaterial.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "SubstanceSourceMaterial.language",
"path" : "SubstanceSourceMaterial.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "SubstanceSourceMaterial.text",
"path" : "SubstanceSourceMaterial.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "SubstanceSourceMaterial.contained",
"path" : "SubstanceSourceMaterial.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "SubstanceSourceMaterial.extension",
"path" : "SubstanceSourceMaterial.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "SubstanceSourceMaterial.modifierExtension",
"path" : "SubstanceSourceMaterial.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "SubstanceSourceMaterial.sourceMaterialClass",
"path" : "SubstanceSourceMaterial.sourceMaterialClass",
"short" : "General high level classification of the source material specific to the origin of the material",
"definition" : "General high level classification of the source material specific to the origin of the material.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceSourceMaterial.sourceMaterialClass",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSourceMaterial.sourceMaterialType",
"path" : "SubstanceSourceMaterial.sourceMaterialType",
"short" : "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",
"definition" : "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.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceSourceMaterial.sourceMaterialType",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSourceMaterial.sourceMaterialState",
"path" : "SubstanceSourceMaterial.sourceMaterialState",
"short" : "The state of the source material when extracted",
"definition" : "The state of the source material when extracted.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceSourceMaterial.sourceMaterialState",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSourceMaterial.organismId",
"path" : "SubstanceSourceMaterial.organismId",
"short" : "The unique identifier associated with the source material parent organism shall be specified",
"definition" : "The unique identifier associated with the source material parent organism shall be specified.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceSourceMaterial.organismId",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Identifier"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSourceMaterial.organismName",
"path" : "SubstanceSourceMaterial.organismName",
"short" : "The organism accepted Scientific name shall be provided based on the organism taxonomy",
"definition" : "The organism accepted Scientific name shall be provided based on the organism taxonomy.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceSourceMaterial.organismName",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSourceMaterial.parentSubstanceId",
"path" : "SubstanceSourceMaterial.parentSubstanceId",
"short" : "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)",
"definition" : "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).",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SubstanceSourceMaterial.parentSubstanceId",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Identifier"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSourceMaterial.parentSubstanceName",
"path" : "SubstanceSourceMaterial.parentSubstanceName",
"short" : "The parent substance of the Herbal Drug, or Herbal preparation",
"definition" : "The parent substance of the Herbal Drug, or Herbal preparation.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SubstanceSourceMaterial.parentSubstanceName",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSourceMaterial.countryOfOrigin",
"path" : "SubstanceSourceMaterial.countryOfOrigin",
"short" : "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",
"definition" : "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.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SubstanceSourceMaterial.countryOfOrigin",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSourceMaterial.geographicalLocation",
"path" : "SubstanceSourceMaterial.geographicalLocation",
"short" : "The place/region where the plant is harvested or the places/regions where the animal source material has its habitat",
"definition" : "The place/region where the plant is harvested or the places/regions where the animal source material has its habitat.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SubstanceSourceMaterial.geographicalLocation",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSourceMaterial.developmentStage",
"path" : "SubstanceSourceMaterial.developmentStage",
"short" : "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)",
"definition" : "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).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceSourceMaterial.developmentStage",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSourceMaterial.fractionDescription",
"path" : "SubstanceSourceMaterial.fractionDescription",
"short" : "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",
"definition" : "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.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SubstanceSourceMaterial.fractionDescription",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSourceMaterial.fractionDescription.id",
"path" : "SubstanceSourceMaterial.fractionDescription.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "SubstanceSourceMaterial.fractionDescription.extension",
"path" : "SubstanceSourceMaterial.fractionDescription.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "SubstanceSourceMaterial.fractionDescription.modifierExtension",
"path" : "SubstanceSourceMaterial.fractionDescription.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "SubstanceSourceMaterial.fractionDescription.fraction",
"path" : "SubstanceSourceMaterial.fractionDescription.fraction",
"short" : "This element is capturing information about the fraction of a plant part, or human plasma for fractionation",
"definition" : "This element is capturing information about the fraction of a plant part, or human plasma for fractionation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceSourceMaterial.fractionDescription.fraction",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSourceMaterial.fractionDescription.materialType",
"path" : "SubstanceSourceMaterial.fractionDescription.materialType",
"short" : "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",
"definition" : "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.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceSourceMaterial.fractionDescription.materialType",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSourceMaterial.organism",
"path" : "SubstanceSourceMaterial.organism",
"short" : "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",
"definition" : "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.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceSourceMaterial.organism",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSourceMaterial.organism.id",
"path" : "SubstanceSourceMaterial.organism.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "SubstanceSourceMaterial.organism.extension",
"path" : "SubstanceSourceMaterial.organism.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "SubstanceSourceMaterial.organism.modifierExtension",
"path" : "SubstanceSourceMaterial.organism.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "SubstanceSourceMaterial.organism.family",
"path" : "SubstanceSourceMaterial.organism.family",
"short" : "The family of an organism shall be specified",
"definition" : "The family of an organism shall be specified.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceSourceMaterial.organism.family",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSourceMaterial.organism.genus",
"path" : "SubstanceSourceMaterial.organism.genus",
"short" : "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",
"definition" : "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.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceSourceMaterial.organism.genus",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSourceMaterial.organism.species",
"path" : "SubstanceSourceMaterial.organism.species",
"short" : "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",
"definition" : "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.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceSourceMaterial.organism.species",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSourceMaterial.organism.intraspecificType",
"path" : "SubstanceSourceMaterial.organism.intraspecificType",
"short" : "The Intraspecific type of an organism shall be specified",
"definition" : "The Intraspecific type of an organism shall be specified.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceSourceMaterial.organism.intraspecificType",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSourceMaterial.organism.intraspecificDescription",
"path" : "SubstanceSourceMaterial.organism.intraspecificDescription",
"short" : "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",
"definition" : "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.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceSourceMaterial.organism.intraspecificDescription",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSourceMaterial.organism.author",
"path" : "SubstanceSourceMaterial.organism.author",
"short" : "4.9.13.6.1 Author type (Conditional)",
"definition" : "4.9.13.6.1 Author type (Conditional).",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SubstanceSourceMaterial.organism.author",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSourceMaterial.organism.author.id",
"path" : "SubstanceSourceMaterial.organism.author.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "SubstanceSourceMaterial.organism.author.extension",
"path" : "SubstanceSourceMaterial.organism.author.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "SubstanceSourceMaterial.organism.author.modifierExtension",
"path" : "SubstanceSourceMaterial.organism.author.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "SubstanceSourceMaterial.organism.author.authorType",
"path" : "SubstanceSourceMaterial.organism.author.authorType",
"short" : "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",
"definition" : "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.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceSourceMaterial.organism.author.authorType",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSourceMaterial.organism.author.authorDescription",
"path" : "SubstanceSourceMaterial.organism.author.authorDescription",
"short" : "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)",
"definition" : "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).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceSourceMaterial.organism.author.authorDescription",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSourceMaterial.organism.hybrid",
"path" : "SubstanceSourceMaterial.organism.hybrid",
"short" : "4.9.13.8.1 Hybrid species maternal organism ID (Optional)",
"definition" : "4.9.13.8.1 Hybrid species maternal organism ID (Optional).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceSourceMaterial.organism.hybrid",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSourceMaterial.organism.hybrid.id",
"path" : "SubstanceSourceMaterial.organism.hybrid.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "SubstanceSourceMaterial.organism.hybrid.extension",
"path" : "SubstanceSourceMaterial.organism.hybrid.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "SubstanceSourceMaterial.organism.hybrid.modifierExtension",
"path" : "SubstanceSourceMaterial.organism.hybrid.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "SubstanceSourceMaterial.organism.hybrid.maternalOrganismId",
"path" : "SubstanceSourceMaterial.organism.hybrid.maternalOrganismId",
"short" : "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",
"definition" : "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.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceSourceMaterial.organism.hybrid.maternalOrganismId",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSourceMaterial.organism.hybrid.maternalOrganismName",
"path" : "SubstanceSourceMaterial.organism.hybrid.maternalOrganismName",
"short" : "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",
"definition" : "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.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceSourceMaterial.organism.hybrid.maternalOrganismName",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSourceMaterial.organism.hybrid.paternalOrganismId",
"path" : "SubstanceSourceMaterial.organism.hybrid.paternalOrganismId",
"short" : "The identifier of the paternal species constituting the hybrid organism shall be specified based on a controlled vocabulary",
"definition" : "The identifier of the paternal species constituting the hybrid organism shall be specified based on a controlled vocabulary.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceSourceMaterial.organism.hybrid.paternalOrganismId",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSourceMaterial.organism.hybrid.paternalOrganismName",
"path" : "SubstanceSourceMaterial.organism.hybrid.paternalOrganismName",
"short" : "The name of the paternal species constituting the hybrid organism shall be specified",
"definition" : "The name of the paternal species constituting the hybrid organism shall be specified.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceSourceMaterial.organism.hybrid.paternalOrganismName",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSourceMaterial.organism.hybrid.hybridType",
"path" : "SubstanceSourceMaterial.organism.hybrid.hybridType",
"short" : "The hybrid type of an organism shall be specified",
"definition" : "The hybrid type of an organism shall be specified.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceSourceMaterial.organism.hybrid.hybridType",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSourceMaterial.organism.organismGeneral",
"path" : "SubstanceSourceMaterial.organism.organismGeneral",
"short" : "4.9.13.7.1 Kingdom (Conditional)",
"definition" : "4.9.13.7.1 Kingdom (Conditional).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceSourceMaterial.organism.organismGeneral",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSourceMaterial.organism.organismGeneral.id",
"path" : "SubstanceSourceMaterial.organism.organismGeneral.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "SubstanceSourceMaterial.organism.organismGeneral.extension",
"path" : "SubstanceSourceMaterial.organism.organismGeneral.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "SubstanceSourceMaterial.organism.organismGeneral.modifierExtension",
"path" : "SubstanceSourceMaterial.organism.organismGeneral.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "SubstanceSourceMaterial.organism.organismGeneral.kingdom",
"path" : "SubstanceSourceMaterial.organism.organismGeneral.kingdom",
"short" : "The kingdom of an organism shall be specified",
"definition" : "The kingdom of an organism shall be specified.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceSourceMaterial.organism.organismGeneral.kingdom",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSourceMaterial.organism.organismGeneral.phylum",
"path" : "SubstanceSourceMaterial.organism.organismGeneral.phylum",
"short" : "The phylum of an organism shall be specified",
"definition" : "The phylum of an organism shall be specified.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceSourceMaterial.organism.organismGeneral.phylum",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSourceMaterial.organism.organismGeneral.class",
"path" : "SubstanceSourceMaterial.organism.organismGeneral.class",
"short" : "The class of an organism shall be specified",
"definition" : "The class of an organism shall be specified.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceSourceMaterial.organism.organismGeneral.class",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSourceMaterial.organism.organismGeneral.order",
"path" : "SubstanceSourceMaterial.organism.organismGeneral.order",
"short" : "The order of an organism shall be specified,",
"definition" : "The order of an organism shall be specified,.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceSourceMaterial.organism.organismGeneral.order",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSourceMaterial.partDescription",
"path" : "SubstanceSourceMaterial.partDescription",
"short" : "To do",
"definition" : "To do.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SubstanceSourceMaterial.partDescription",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSourceMaterial.partDescription.id",
"path" : "SubstanceSourceMaterial.partDescription.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "SubstanceSourceMaterial.partDescription.extension",
"path" : "SubstanceSourceMaterial.partDescription.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "SubstanceSourceMaterial.partDescription.modifierExtension",
"path" : "SubstanceSourceMaterial.partDescription.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "SubstanceSourceMaterial.partDescription.part",
"path" : "SubstanceSourceMaterial.partDescription.part",
"short" : "Entity of anatomical origin of source material within an organism",
"definition" : "Entity of anatomical origin of source material within an organism.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceSourceMaterial.partDescription.part",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSourceMaterial.partDescription.partLocation",
"path" : "SubstanceSourceMaterial.partDescription.partLocation",
"short" : "The detailed anatomic location when the part can be extracted from different anatomical locations of the organism. Multiple alternative locations may apply",
"definition" : "The detailed anatomic location when the part can be extracted from different anatomical locations of the organism. Multiple alternative locations may apply.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceSourceMaterial.partDescription.partLocation",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
}]
},
"differential" : {
"element" : [{
"id" : "SubstanceSourceMaterial",
"path" : "SubstanceSourceMaterial",
"short" : "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",
"definition" : "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.",
"min" : 0,
"max" : "*"
},
{
"id" : "SubstanceSourceMaterial.sourceMaterialClass",
"path" : "SubstanceSourceMaterial.sourceMaterialClass",
"short" : "General high level classification of the source material specific to the origin of the material",
"definition" : "General high level classification of the source material specific to the origin of the material.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "SubstanceSourceMaterial.sourceMaterialType",
"path" : "SubstanceSourceMaterial.sourceMaterialType",
"short" : "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",
"definition" : "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.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "SubstanceSourceMaterial.sourceMaterialState",
"path" : "SubstanceSourceMaterial.sourceMaterialState",
"short" : "The state of the source material when extracted",
"definition" : "The state of the source material when extracted.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "SubstanceSourceMaterial.organismId",
"path" : "SubstanceSourceMaterial.organismId",
"short" : "The unique identifier associated with the source material parent organism shall be specified",
"definition" : "The unique identifier associated with the source material parent organism shall be specified.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Identifier"
}],
"isSummary" : true
},
{
"id" : "SubstanceSourceMaterial.organismName",
"path" : "SubstanceSourceMaterial.organismName",
"short" : "The organism accepted Scientific name shall be provided based on the organism taxonomy",
"definition" : "The organism accepted Scientific name shall be provided based on the organism taxonomy.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "SubstanceSourceMaterial.parentSubstanceId",
"path" : "SubstanceSourceMaterial.parentSubstanceId",
"short" : "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)",
"definition" : "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).",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Identifier"
}],
"isSummary" : true
},
{
"id" : "SubstanceSourceMaterial.parentSubstanceName",
"path" : "SubstanceSourceMaterial.parentSubstanceName",
"short" : "The parent substance of the Herbal Drug, or Herbal preparation",
"definition" : "The parent substance of the Herbal Drug, or Herbal preparation.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "SubstanceSourceMaterial.countryOfOrigin",
"path" : "SubstanceSourceMaterial.countryOfOrigin",
"short" : "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",
"definition" : "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.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "SubstanceSourceMaterial.geographicalLocation",
"path" : "SubstanceSourceMaterial.geographicalLocation",
"short" : "The place/region where the plant is harvested or the places/regions where the animal source material has its habitat",
"definition" : "The place/region where the plant is harvested or the places/regions where the animal source material has its habitat.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "SubstanceSourceMaterial.developmentStage",
"path" : "SubstanceSourceMaterial.developmentStage",
"short" : "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)",
"definition" : "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).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "SubstanceSourceMaterial.fractionDescription",
"path" : "SubstanceSourceMaterial.fractionDescription",
"short" : "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",
"definition" : "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.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"isSummary" : true
},
{
"id" : "SubstanceSourceMaterial.fractionDescription.fraction",
"path" : "SubstanceSourceMaterial.fractionDescription.fraction",
"short" : "This element is capturing information about the fraction of a plant part, or human plasma for fractionation",
"definition" : "This element is capturing information about the fraction of a plant part, or human plasma for fractionation.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "SubstanceSourceMaterial.fractionDescription.materialType",
"path" : "SubstanceSourceMaterial.fractionDescription.materialType",
"short" : "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",
"definition" : "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.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "SubstanceSourceMaterial.organism",
"path" : "SubstanceSourceMaterial.organism",
"short" : "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",
"definition" : "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.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "BackboneElement"
}],
"isSummary" : true
},
{
"id" : "SubstanceSourceMaterial.organism.family",
"path" : "SubstanceSourceMaterial.organism.family",
"short" : "The family of an organism shall be specified",
"definition" : "The family of an organism shall be specified.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "SubstanceSourceMaterial.organism.genus",
"path" : "SubstanceSourceMaterial.organism.genus",
"short" : "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",
"definition" : "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.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "SubstanceSourceMaterial.organism.species",
"path" : "SubstanceSourceMaterial.organism.species",
"short" : "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",
"definition" : "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.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "SubstanceSourceMaterial.organism.intraspecificType",
"path" : "SubstanceSourceMaterial.organism.intraspecificType",
"short" : "The Intraspecific type of an organism shall be specified",
"definition" : "The Intraspecific type of an organism shall be specified.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "SubstanceSourceMaterial.organism.intraspecificDescription",
"path" : "SubstanceSourceMaterial.organism.intraspecificDescription",
"short" : "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",
"definition" : "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.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "SubstanceSourceMaterial.organism.author",
"path" : "SubstanceSourceMaterial.organism.author",
"short" : "4.9.13.6.1 Author type (Conditional)",
"definition" : "4.9.13.6.1 Author type (Conditional).",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"isSummary" : true
},
{
"id" : "SubstanceSourceMaterial.organism.author.authorType",
"path" : "SubstanceSourceMaterial.organism.author.authorType",
"short" : "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",
"definition" : "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.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "SubstanceSourceMaterial.organism.author.authorDescription",
"path" : "SubstanceSourceMaterial.organism.author.authorDescription",
"short" : "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)",
"definition" : "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).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "SubstanceSourceMaterial.organism.hybrid",
"path" : "SubstanceSourceMaterial.organism.hybrid",
"short" : "4.9.13.8.1 Hybrid species maternal organism ID (Optional)",
"definition" : "4.9.13.8.1 Hybrid species maternal organism ID (Optional).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "BackboneElement"
}],
"isSummary" : true
},
{
"id" : "SubstanceSourceMaterial.organism.hybrid.maternalOrganismId",
"path" : "SubstanceSourceMaterial.organism.hybrid.maternalOrganismId",
"short" : "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",
"definition" : "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.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "SubstanceSourceMaterial.organism.hybrid.maternalOrganismName",
"path" : "SubstanceSourceMaterial.organism.hybrid.maternalOrganismName",
"short" : "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",
"definition" : "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.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "SubstanceSourceMaterial.organism.hybrid.paternalOrganismId",
"path" : "SubstanceSourceMaterial.organism.hybrid.paternalOrganismId",
"short" : "The identifier of the paternal species constituting the hybrid organism shall be specified based on a controlled vocabulary",
"definition" : "The identifier of the paternal species constituting the hybrid organism shall be specified based on a controlled vocabulary.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "SubstanceSourceMaterial.organism.hybrid.paternalOrganismName",
"path" : "SubstanceSourceMaterial.organism.hybrid.paternalOrganismName",
"short" : "The name of the paternal species constituting the hybrid organism shall be specified",
"definition" : "The name of the paternal species constituting the hybrid organism shall be specified.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "SubstanceSourceMaterial.organism.hybrid.hybridType",
"path" : "SubstanceSourceMaterial.organism.hybrid.hybridType",
"short" : "The hybrid type of an organism shall be specified",
"definition" : "The hybrid type of an organism shall be specified.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "SubstanceSourceMaterial.organism.organismGeneral",
"path" : "SubstanceSourceMaterial.organism.organismGeneral",
"short" : "4.9.13.7.1 Kingdom (Conditional)",
"definition" : "4.9.13.7.1 Kingdom (Conditional).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "BackboneElement"
}],
"isSummary" : true
},
{
"id" : "SubstanceSourceMaterial.organism.organismGeneral.kingdom",
"path" : "SubstanceSourceMaterial.organism.organismGeneral.kingdom",
"short" : "The kingdom of an organism shall be specified",
"definition" : "The kingdom of an organism shall be specified.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "SubstanceSourceMaterial.organism.organismGeneral.phylum",
"path" : "SubstanceSourceMaterial.organism.organismGeneral.phylum",
"short" : "The phylum of an organism shall be specified",
"definition" : "The phylum of an organism shall be specified.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "SubstanceSourceMaterial.organism.organismGeneral.class",
"path" : "SubstanceSourceMaterial.organism.organismGeneral.class",
"short" : "The class of an organism shall be specified",
"definition" : "The class of an organism shall be specified.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "SubstanceSourceMaterial.organism.organismGeneral.order",
"path" : "SubstanceSourceMaterial.organism.organismGeneral.order",
"short" : "The order of an organism shall be specified,",
"definition" : "The order of an organism shall be specified,.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "SubstanceSourceMaterial.partDescription",
"path" : "SubstanceSourceMaterial.partDescription",
"short" : "To do",
"definition" : "To do.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"isSummary" : true
},
{
"id" : "SubstanceSourceMaterial.partDescription.part",
"path" : "SubstanceSourceMaterial.partDescription.part",
"short" : "Entity of anatomical origin of source material within an organism",
"definition" : "Entity of anatomical origin of source material within an organism.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "SubstanceSourceMaterial.partDescription.partLocation",
"path" : "SubstanceSourceMaterial.partDescription.partLocation",
"short" : "The detailed anatomic location when the part can be extracted from different anatomical locations of the organism. Multiple alternative locations may apply",
"definition" : "The detailed anatomic location when the part can be extracted from different anatomical locations of the organism. Multiple alternative locations may apply.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
}]
}
}
},
{
"fullUrl" : "http://hl7.org/fhir/StructureDefinition/SubstanceSpecification",
"resource" : {
"resourceType" : "StructureDefinition",
"id" : "SubstanceSpecification",
"meta" : {
"lastUpdated" : "2019-11-01T09:29:23.356+11:00"
},
"text" : {
"status" : "generated",
"div" : "Name Flags Card. Type Description & Constraints SubstanceSpecification Σ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 identifier Σ 0..1 Identifier Identifier by which this substance is known type Σ 0..1 CodeableConcept High level categorization, e.g. polymer or nucleic acid status Σ 0..1 CodeableConcept Status of substance within the catalogue e.g. approved domain Σ 0..1 CodeableConcept If the substance applies to only human or veterinary use description Σ 0..1 string Textual description of the substance source Σ 0..* Reference(DocumentReference) Supporting literature
comment Σ 0..1 string Textual comment about this record of a substance moiety Σ 0..* BackboneElement Moiety, for structural modifications
role Σ 0..1 CodeableConcept Role that the moiety is playing identifier Σ 0..1 Identifier Identifier by which this moiety substance is known name Σ 0..1 string Textual name for this moiety substance stereochemistry Σ 0..1 CodeableConcept Stereochemistry type opticalActivity Σ 0..1 CodeableConcept Optical activity type molecularFormula Σ 0..1 string Molecular formula amount[x] Σ 0..1 Quantitative value for this moiety amountQuantity Quantity amountString string property Σ 0..* BackboneElement General specifications for this substance, including how it is related to other substances
category Σ 0..1 CodeableConcept A category for this property, e.g. Physical, Chemical, Enzymatic code Σ 0..1 CodeableConcept Property type e.g. viscosity, pH, isoelectric point parameters Σ 0..1 string Parameters that were used in the measurement of a property (e.g. for viscosity: measured at 20C with a pH of 7.1) definingSubstance[x] Σ 0..1 A substance upon which a defining property depends (e.g. for solubility: in water, in alcohol) definingSubstanceReference Reference(SubstanceSpecification | Substance) definingSubstanceCodeableConcept CodeableConcept amount[x] Σ 0..1 Quantitative value for this property amountQuantity Quantity amountString string referenceInformation Σ 0..1 Reference(SubstanceReferenceInformation) General information detailing this substance structure Σ 0..1 BackboneElement Structural information stereochemistry Σ 0..1 CodeableConcept Stereochemistry type opticalActivity Σ 0..1 CodeableConcept Optical activity type molecularFormula Σ 0..1 string Molecular formula molecularFormulaByMoiety Σ 0..1 string Specified per moiety according to the Hill system, i.e. first C, then H, then alphabetical, each moiety separated by a dot isotope Σ 0..* BackboneElement Applicable for single substances that contain a radionuclide or a non-natural isotopic ratio
identifier Σ 0..1 Identifier Substance identifier for each non-natural or radioisotope name Σ 0..1 CodeableConcept Substance name for each non-natural or radioisotope substitution Σ 0..1 CodeableConcept The type of isotopic substitution present in a single substance halfLife Σ 0..1 Quantity Half life - for a non-natural nuclide molecularWeight Σ 0..1 BackboneElement The molecular weight or weight range (for proteins, polymers or nucleic acids) method Σ 0..1 CodeableConcept The method by which the molecular weight was determined type Σ 0..1 CodeableConcept Type of molecular weight such as exact, average (also known as. number average), weight average amount Σ 0..1 Quantity Used to capture quantitative values for a variety of elements. If only limits are given, the arithmetic mean would be the average. If only a single definite value for a given element is given, it would be captured in this field molecularWeight Σ 0..1 see molecularWeight The molecular weight or weight range (for proteins, polymers or nucleic acids) source Σ 0..* Reference(DocumentReference) Supporting literature
representation Σ 0..* BackboneElement Molecular structural representation
type Σ 0..1 CodeableConcept The type of structure (e.g. Full, Partial, Representative) representation Σ 0..1 string The structural representation as text string in a format e.g. InChI, SMILES, MOLFILE, CDX attachment Σ 0..1 Attachment An attached file with the structural representation code Σ 0..* BackboneElement Codes associated with the substance
code Σ 0..1 CodeableConcept The specific code status Σ 0..1 CodeableConcept Status of the code assignment statusDate Σ 0..1 dateTime The date at which the code status is changed as part of the terminology maintenance comment Σ 0..1 string Any comment can be provided in this field, if necessary source Σ 0..* Reference(DocumentReference) Supporting literature
name Σ 0..* BackboneElement Names applicable to this substance
name Σ 1..1 string The actual name type Σ 0..1 CodeableConcept Name type status Σ 0..1 CodeableConcept The status of the name preferred Σ 0..1 boolean If this is the preferred name for this substance language Σ 0..* CodeableConcept Language of the name
domain Σ 0..* CodeableConcept The use context of this name for example if there is a different name a drug active ingredient as opposed to a food colour additive
jurisdiction Σ 0..* CodeableConcept The jurisdiction where this name applies
synonym Σ 0..* see name A synonym of this name
translation Σ 0..* see name A translation for this name
official Σ 0..* BackboneElement Details of the official nature of this name
authority Σ 0..1 CodeableConcept Which authority uses this official name status Σ 0..1 CodeableConcept The status of the official name date Σ 0..1 dateTime Date of official name change source Σ 0..* Reference(DocumentReference) Supporting literature
molecularWeight Σ 0..* see molecularWeight The molecular weight or weight range (for proteins, polymers or nucleic acids)
relationship Σ 0..* BackboneElement A link between this substance and another, with details of the relationship
substance[x] Σ 0..1 A pointer to another substance, as a resource or just a representational code substanceReference Reference(SubstanceSpecification) substanceCodeableConcept CodeableConcept relationship Σ 0..1 CodeableConcept For example "salt to parent", "active moiety", "starting material" isDefining Σ 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 substance relationships amount[x] Σ 0..1 A numeric factor for the relationship, for instance to express that the salt of a substance has some percentage of the active substance in relation to some other amountQuantity Quantity amountRange Range amountRatio Ratio amountString string amountRatioLowLimit Σ 0..1 Ratio For use when the numeric amountType Σ 0..1 CodeableConcept An operator for the amount, for example "average", "approximately", "less than" source Σ 0..* Reference(DocumentReference) Supporting literature
nucleicAcid Σ 0..1 Reference(SubstanceNucleicAcid) Data items specific to nucleic acids polymer Σ 0..1 Reference(SubstancePolymer) Data items specific to polymers protein Σ 0..1 Reference(SubstanceProtein) Data items specific to proteins sourceMaterial Σ 0..1 Reference(SubstanceSourceMaterial) Material or taxonomic/anatomical source for the substance
Documentation for this format
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Specialized.Medication Definition"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 0
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "anonymous"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "brr"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/SubstanceSpecification",
"version" : "4.0.1",
"name" : "SubstanceSpecification",
"status" : "draft",
"date" : "2019-11-01T09:29:23+11:00",
"publisher" : "Health Level Seven International (Biomedical Research and Regulation)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/rcrim/index.cfm"
}]
}],
"description" : "The detailed description of a substance, typically at a level beyond what is used for prescribing.",
"fhirVersion" : "4.0.1",
"mapping" : [{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
}],
"kind" : "resource",
"abstract" : false,
"type" : "SubstanceSpecification",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "SubstanceSpecification",
"path" : "SubstanceSpecification",
"short" : "The detailed description of a substance, typically at a level beyond what is used for prescribing",
"definition" : "The detailed description of a substance, typically at a level beyond what is used for prescribing.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SubstanceSpecification",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "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",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.`div`.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
}]
},
{
"id" : "SubstanceSpecification.id",
"path" : "SubstanceSpecification.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSpecification.meta",
"path" : "SubstanceSpecification.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSpecification.implicitRules",
"path" : "SubstanceSpecification.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "SubstanceSpecification.language",
"path" : "SubstanceSpecification.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "SubstanceSpecification.text",
"path" : "SubstanceSpecification.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "SubstanceSpecification.contained",
"path" : "SubstanceSpecification.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "SubstanceSpecification.extension",
"path" : "SubstanceSpecification.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "SubstanceSpecification.modifierExtension",
"path" : "SubstanceSpecification.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "SubstanceSpecification.identifier",
"path" : "SubstanceSpecification.identifier",
"short" : "Identifier by which this substance is known",
"definition" : "Identifier by which this substance is known.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceSpecification.identifier",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Identifier"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSpecification.type",
"path" : "SubstanceSpecification.type",
"short" : "High level categorization, e.g. polymer or nucleic acid",
"definition" : "High level categorization, e.g. polymer or nucleic acid.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceSpecification.type",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSpecification.status",
"path" : "SubstanceSpecification.status",
"short" : "Status of substance within the catalogue e.g. approved",
"definition" : "Status of substance within the catalogue e.g. approved.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceSpecification.status",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSpecification.domain",
"path" : "SubstanceSpecification.domain",
"short" : "If the substance applies to only human or veterinary use",
"definition" : "If the substance applies to only human or veterinary use.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceSpecification.domain",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSpecification.description",
"path" : "SubstanceSpecification.description",
"short" : "Textual description of the substance",
"definition" : "Textual description of the substance.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceSpecification.description",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSpecification.source",
"path" : "SubstanceSpecification.source",
"short" : "Supporting literature",
"definition" : "Supporting literature.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SubstanceSpecification.source",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/DocumentReference"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSpecification.comment",
"path" : "SubstanceSpecification.comment",
"short" : "Textual comment about this record of a substance",
"definition" : "Textual comment about this record of a substance.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceSpecification.comment",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSpecification.moiety",
"path" : "SubstanceSpecification.moiety",
"short" : "Moiety, for structural modifications",
"definition" : "Moiety, for structural modifications.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SubstanceSpecification.moiety",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSpecification.moiety.id",
"path" : "SubstanceSpecification.moiety.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "SubstanceSpecification.moiety.extension",
"path" : "SubstanceSpecification.moiety.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "SubstanceSpecification.moiety.modifierExtension",
"path" : "SubstanceSpecification.moiety.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "SubstanceSpecification.moiety.role",
"path" : "SubstanceSpecification.moiety.role",
"short" : "Role that the moiety is playing",
"definition" : "Role that the moiety is playing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceSpecification.moiety.role",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSpecification.moiety.identifier",
"path" : "SubstanceSpecification.moiety.identifier",
"short" : "Identifier by which this moiety substance is known",
"definition" : "Identifier by which this moiety substance is known.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceSpecification.moiety.identifier",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Identifier"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSpecification.moiety.name",
"path" : "SubstanceSpecification.moiety.name",
"short" : "Textual name for this moiety substance",
"definition" : "Textual name for this moiety substance.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceSpecification.moiety.name",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSpecification.moiety.stereochemistry",
"path" : "SubstanceSpecification.moiety.stereochemistry",
"short" : "Stereochemistry type",
"definition" : "Stereochemistry type.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceSpecification.moiety.stereochemistry",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSpecification.moiety.opticalActivity",
"path" : "SubstanceSpecification.moiety.opticalActivity",
"short" : "Optical activity type",
"definition" : "Optical activity type.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceSpecification.moiety.opticalActivity",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSpecification.moiety.molecularFormula",
"path" : "SubstanceSpecification.moiety.molecularFormula",
"short" : "Molecular formula",
"definition" : "Molecular formula.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceSpecification.moiety.molecularFormula",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSpecification.moiety.amount[x]",
"path" : "SubstanceSpecification.moiety.amount[x]",
"short" : "Quantitative value for this moiety",
"definition" : "Quantitative value for this moiety.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceSpecification.moiety.amount[x]",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Quantity"
},
{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSpecification.property",
"path" : "SubstanceSpecification.property",
"short" : "General specifications for this substance, including how it is related to other substances",
"definition" : "General specifications for this substance, including how it is related to other substances.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SubstanceSpecification.property",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSpecification.property.id",
"path" : "SubstanceSpecification.property.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "SubstanceSpecification.property.extension",
"path" : "SubstanceSpecification.property.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "SubstanceSpecification.property.modifierExtension",
"path" : "SubstanceSpecification.property.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "SubstanceSpecification.property.category",
"path" : "SubstanceSpecification.property.category",
"short" : "A category for this property, e.g. Physical, Chemical, Enzymatic",
"definition" : "A category for this property, e.g. Physical, Chemical, Enzymatic.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceSpecification.property.category",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSpecification.property.code",
"path" : "SubstanceSpecification.property.code",
"short" : "Property type e.g. viscosity, pH, isoelectric point",
"definition" : "Property type e.g. viscosity, pH, isoelectric point.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceSpecification.property.code",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSpecification.property.parameters",
"path" : "SubstanceSpecification.property.parameters",
"short" : "Parameters that were used in the measurement of a property (e.g. for viscosity: measured at 20C with a pH of 7.1)",
"definition" : "Parameters that were used in the measurement of a property (e.g. for viscosity: measured at 20C with a pH of 7.1).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceSpecification.property.parameters",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSpecification.property.definingSubstance[x]",
"path" : "SubstanceSpecification.property.definingSubstance[x]",
"short" : "A substance upon which a defining property depends (e.g. for solubility: in water, in alcohol)",
"definition" : "A substance upon which a defining property depends (e.g. for solubility: in water, in alcohol).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceSpecification.property.definingSubstance[x]",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/SubstanceSpecification",
"http://hl7.org/fhir/StructureDefinition/Substance"]
},
{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSpecification.property.amount[x]",
"path" : "SubstanceSpecification.property.amount[x]",
"short" : "Quantitative value for this property",
"definition" : "Quantitative value for this property.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceSpecification.property.amount[x]",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Quantity"
},
{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSpecification.referenceInformation",
"path" : "SubstanceSpecification.referenceInformation",
"short" : "General information detailing this substance",
"definition" : "General information detailing this substance.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceSpecification.referenceInformation",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/SubstanceReferenceInformation"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSpecification.structure",
"path" : "SubstanceSpecification.structure",
"short" : "Structural information",
"definition" : "Structural information.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceSpecification.structure",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSpecification.structure.id",
"path" : "SubstanceSpecification.structure.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "SubstanceSpecification.structure.extension",
"path" : "SubstanceSpecification.structure.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "SubstanceSpecification.structure.modifierExtension",
"path" : "SubstanceSpecification.structure.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "SubstanceSpecification.structure.stereochemistry",
"path" : "SubstanceSpecification.structure.stereochemistry",
"short" : "Stereochemistry type",
"definition" : "Stereochemistry type.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceSpecification.structure.stereochemistry",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSpecification.structure.opticalActivity",
"path" : "SubstanceSpecification.structure.opticalActivity",
"short" : "Optical activity type",
"definition" : "Optical activity type.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceSpecification.structure.opticalActivity",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSpecification.structure.molecularFormula",
"path" : "SubstanceSpecification.structure.molecularFormula",
"short" : "Molecular formula",
"definition" : "Molecular formula.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceSpecification.structure.molecularFormula",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSpecification.structure.molecularFormulaByMoiety",
"path" : "SubstanceSpecification.structure.molecularFormulaByMoiety",
"short" : "Specified per moiety according to the Hill system, i.e. first C, then H, then alphabetical, each moiety separated by a dot",
"definition" : "Specified per moiety according to the Hill system, i.e. first C, then H, then alphabetical, each moiety separated by a dot.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceSpecification.structure.molecularFormulaByMoiety",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSpecification.structure.isotope",
"path" : "SubstanceSpecification.structure.isotope",
"short" : "Applicable for single substances that contain a radionuclide or a non-natural isotopic ratio",
"definition" : "Applicable for single substances that contain a radionuclide or a non-natural isotopic ratio.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SubstanceSpecification.structure.isotope",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSpecification.structure.isotope.id",
"path" : "SubstanceSpecification.structure.isotope.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "SubstanceSpecification.structure.isotope.extension",
"path" : "SubstanceSpecification.structure.isotope.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "SubstanceSpecification.structure.isotope.modifierExtension",
"path" : "SubstanceSpecification.structure.isotope.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "SubstanceSpecification.structure.isotope.identifier",
"path" : "SubstanceSpecification.structure.isotope.identifier",
"short" : "Substance identifier for each non-natural or radioisotope",
"definition" : "Substance identifier for each non-natural or radioisotope.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceSpecification.structure.isotope.identifier",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Identifier"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSpecification.structure.isotope.name",
"path" : "SubstanceSpecification.structure.isotope.name",
"short" : "Substance name for each non-natural or radioisotope",
"definition" : "Substance name for each non-natural or radioisotope.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceSpecification.structure.isotope.name",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSpecification.structure.isotope.substitution",
"path" : "SubstanceSpecification.structure.isotope.substitution",
"short" : "The type of isotopic substitution present in a single substance",
"definition" : "The type of isotopic substitution present in a single substance.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceSpecification.structure.isotope.substitution",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSpecification.structure.isotope.halfLife",
"path" : "SubstanceSpecification.structure.isotope.halfLife",
"short" : "Half life - for a non-natural nuclide",
"definition" : "Half life - for a non-natural nuclide.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceSpecification.structure.isotope.halfLife",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Quantity"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSpecification.structure.isotope.molecularWeight",
"path" : "SubstanceSpecification.structure.isotope.molecularWeight",
"short" : "The molecular weight or weight range (for proteins, polymers or nucleic acids)",
"definition" : "The molecular weight or weight range (for proteins, polymers or nucleic acids).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceSpecification.structure.isotope.molecularWeight",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSpecification.structure.isotope.molecularWeight.id",
"path" : "SubstanceSpecification.structure.isotope.molecularWeight.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "SubstanceSpecification.structure.isotope.molecularWeight.extension",
"path" : "SubstanceSpecification.structure.isotope.molecularWeight.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "SubstanceSpecification.structure.isotope.molecularWeight.modifierExtension",
"path" : "SubstanceSpecification.structure.isotope.molecularWeight.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "SubstanceSpecification.structure.isotope.molecularWeight.method",
"path" : "SubstanceSpecification.structure.isotope.molecularWeight.method",
"short" : "The method by which the molecular weight was determined",
"definition" : "The method by which the molecular weight was determined.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceSpecification.structure.isotope.molecularWeight.method",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSpecification.structure.isotope.molecularWeight.type",
"path" : "SubstanceSpecification.structure.isotope.molecularWeight.type",
"short" : "Type of molecular weight such as exact, average (also known as. number average), weight average",
"definition" : "Type of molecular weight such as exact, average (also known as. number average), weight average.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceSpecification.structure.isotope.molecularWeight.type",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSpecification.structure.isotope.molecularWeight.amount",
"path" : "SubstanceSpecification.structure.isotope.molecularWeight.amount",
"short" : "Used to capture quantitative values for a variety of elements. If only limits are given, the arithmetic mean would be the average. If only a single definite value for a given element is given, it would be captured in this field",
"definition" : "Used to capture quantitative values for a variety of elements. If only limits are given, the arithmetic mean would be the average. If only a single definite value for a given element is given, it would be captured in this field.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceSpecification.structure.isotope.molecularWeight.amount",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Quantity"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSpecification.structure.molecularWeight",
"path" : "SubstanceSpecification.structure.molecularWeight",
"short" : "The molecular weight or weight range (for proteins, polymers or nucleic acids)",
"definition" : "The molecular weight or weight range (for proteins, polymers or nucleic acids).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceSpecification.structure.molecularWeight",
"min" : 0,
"max" : "1"
},
"contentReference" : "#SubstanceSpecification.structure.isotope.molecularWeight",
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSpecification.structure.source",
"path" : "SubstanceSpecification.structure.source",
"short" : "Supporting literature",
"definition" : "Supporting literature.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SubstanceSpecification.structure.source",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/DocumentReference"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSpecification.structure.representation",
"path" : "SubstanceSpecification.structure.representation",
"short" : "Molecular structural representation",
"definition" : "Molecular structural representation.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SubstanceSpecification.structure.representation",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSpecification.structure.representation.id",
"path" : "SubstanceSpecification.structure.representation.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "SubstanceSpecification.structure.representation.extension",
"path" : "SubstanceSpecification.structure.representation.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "SubstanceSpecification.structure.representation.modifierExtension",
"path" : "SubstanceSpecification.structure.representation.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "SubstanceSpecification.structure.representation.type",
"path" : "SubstanceSpecification.structure.representation.type",
"short" : "The type of structure (e.g. Full, Partial, Representative)",
"definition" : "The type of structure (e.g. Full, Partial, Representative).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceSpecification.structure.representation.type",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSpecification.structure.representation.representation",
"path" : "SubstanceSpecification.structure.representation.representation",
"short" : "The structural representation as text string in a format e.g. InChI, SMILES, MOLFILE, CDX",
"definition" : "The structural representation as text string in a format e.g. InChI, SMILES, MOLFILE, CDX.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceSpecification.structure.representation.representation",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSpecification.structure.representation.attachment",
"path" : "SubstanceSpecification.structure.representation.attachment",
"short" : "An attached file with the structural representation",
"definition" : "An attached file with the structural representation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceSpecification.structure.representation.attachment",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Attachment"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSpecification.code",
"path" : "SubstanceSpecification.code",
"short" : "Codes associated with the substance",
"definition" : "Codes associated with the substance.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SubstanceSpecification.code",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSpecification.code.id",
"path" : "SubstanceSpecification.code.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "SubstanceSpecification.code.extension",
"path" : "SubstanceSpecification.code.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "SubstanceSpecification.code.modifierExtension",
"path" : "SubstanceSpecification.code.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "SubstanceSpecification.code.code",
"path" : "SubstanceSpecification.code.code",
"short" : "The specific code",
"definition" : "The specific code.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceSpecification.code.code",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSpecification.code.status",
"path" : "SubstanceSpecification.code.status",
"short" : "Status of the code assignment",
"definition" : "Status of the code assignment.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceSpecification.code.status",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSpecification.code.statusDate",
"path" : "SubstanceSpecification.code.statusDate",
"short" : "The date at which the code status is changed as part of the terminology maintenance",
"definition" : "The date at which the code status is changed as part of the terminology maintenance.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceSpecification.code.statusDate",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSpecification.code.comment",
"path" : "SubstanceSpecification.code.comment",
"short" : "Any comment can be provided in this field, if necessary",
"definition" : "Any comment can be provided in this field, if necessary.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceSpecification.code.comment",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSpecification.code.source",
"path" : "SubstanceSpecification.code.source",
"short" : "Supporting literature",
"definition" : "Supporting literature.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SubstanceSpecification.code.source",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/DocumentReference"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSpecification.name",
"path" : "SubstanceSpecification.name",
"short" : "Names applicable to this substance",
"definition" : "Names applicable to this substance.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SubstanceSpecification.name",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSpecification.name.id",
"path" : "SubstanceSpecification.name.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "SubstanceSpecification.name.extension",
"path" : "SubstanceSpecification.name.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "SubstanceSpecification.name.modifierExtension",
"path" : "SubstanceSpecification.name.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "SubstanceSpecification.name.name",
"path" : "SubstanceSpecification.name.name",
"short" : "The actual name",
"definition" : "The actual name.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "SubstanceSpecification.name.name",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSpecification.name.type",
"path" : "SubstanceSpecification.name.type",
"short" : "Name type",
"definition" : "Name type.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceSpecification.name.type",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSpecification.name.status",
"path" : "SubstanceSpecification.name.status",
"short" : "The status of the name",
"definition" : "The status of the name.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceSpecification.name.status",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSpecification.name.preferred",
"path" : "SubstanceSpecification.name.preferred",
"short" : "If this is the preferred name for this substance",
"definition" : "If this is the preferred name for this substance.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceSpecification.name.preferred",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSpecification.name.language",
"path" : "SubstanceSpecification.name.language",
"short" : "Language of the name",
"definition" : "Language of the name.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SubstanceSpecification.name.language",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSpecification.name.domain",
"path" : "SubstanceSpecification.name.domain",
"short" : "The use context of this name for example if there is a different name a drug active ingredient as opposed to a food colour additive",
"definition" : "The use context of this name for example if there is a different name a drug active ingredient as opposed to a food colour additive.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SubstanceSpecification.name.domain",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSpecification.name.jurisdiction",
"path" : "SubstanceSpecification.name.jurisdiction",
"short" : "The jurisdiction where this name applies",
"definition" : "The jurisdiction where this name applies.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SubstanceSpecification.name.jurisdiction",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSpecification.name.synonym",
"path" : "SubstanceSpecification.name.synonym",
"short" : "A synonym of this name",
"definition" : "A synonym of this name.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SubstanceSpecification.name.synonym",
"min" : 0,
"max" : "*"
},
"contentReference" : "#SubstanceSpecification.name",
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSpecification.name.translation",
"path" : "SubstanceSpecification.name.translation",
"short" : "A translation for this name",
"definition" : "A translation for this name.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SubstanceSpecification.name.translation",
"min" : 0,
"max" : "*"
},
"contentReference" : "#SubstanceSpecification.name",
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSpecification.name.official",
"path" : "SubstanceSpecification.name.official",
"short" : "Details of the official nature of this name",
"definition" : "Details of the official nature of this name.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SubstanceSpecification.name.official",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSpecification.name.official.id",
"path" : "SubstanceSpecification.name.official.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "SubstanceSpecification.name.official.extension",
"path" : "SubstanceSpecification.name.official.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "SubstanceSpecification.name.official.modifierExtension",
"path" : "SubstanceSpecification.name.official.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "SubstanceSpecification.name.official.authority",
"path" : "SubstanceSpecification.name.official.authority",
"short" : "Which authority uses this official name",
"definition" : "Which authority uses this official name.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceSpecification.name.official.authority",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSpecification.name.official.status",
"path" : "SubstanceSpecification.name.official.status",
"short" : "The status of the official name",
"definition" : "The status of the official name.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceSpecification.name.official.status",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSpecification.name.official.date",
"path" : "SubstanceSpecification.name.official.date",
"short" : "Date of official name change",
"definition" : "Date of official name change.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceSpecification.name.official.date",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSpecification.name.source",
"path" : "SubstanceSpecification.name.source",
"short" : "Supporting literature",
"definition" : "Supporting literature.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SubstanceSpecification.name.source",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/DocumentReference"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSpecification.molecularWeight",
"path" : "SubstanceSpecification.molecularWeight",
"short" : "The molecular weight or weight range (for proteins, polymers or nucleic acids)",
"definition" : "The molecular weight or weight range (for proteins, polymers or nucleic acids).",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SubstanceSpecification.molecularWeight",
"min" : 0,
"max" : "*"
},
"contentReference" : "#SubstanceSpecification.structure.isotope.molecularWeight",
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSpecification.relationship",
"path" : "SubstanceSpecification.relationship",
"short" : "A link between this substance and another, with details of the relationship",
"definition" : "A link between this substance and another, with details of the relationship.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SubstanceSpecification.relationship",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSpecification.relationship.id",
"path" : "SubstanceSpecification.relationship.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "SubstanceSpecification.relationship.extension",
"path" : "SubstanceSpecification.relationship.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "SubstanceSpecification.relationship.modifierExtension",
"path" : "SubstanceSpecification.relationship.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "SubstanceSpecification.relationship.substance[x]",
"path" : "SubstanceSpecification.relationship.substance[x]",
"short" : "A pointer to another substance, as a resource or just a representational code",
"definition" : "A pointer to another substance, as a resource or just a representational code.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceSpecification.relationship.substance[x]",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/SubstanceSpecification"]
},
{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSpecification.relationship.relationship",
"path" : "SubstanceSpecification.relationship.relationship",
"short" : "For example \"salt to parent\", \"active moiety\", \"starting material\"",
"definition" : "For example \"salt to parent\", \"active moiety\", \"starting material\".",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceSpecification.relationship.relationship",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSpecification.relationship.isDefining",
"path" : "SubstanceSpecification.relationship.isDefining",
"short" : "For example where an enzyme strongly bonds with a particular substance, this is a defining relationship for that enzyme, out of several possible substance relationships",
"definition" : "For example where an enzyme strongly bonds with a particular substance, this is a defining relationship for that enzyme, out of several possible substance relationships.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceSpecification.relationship.isDefining",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSpecification.relationship.amount[x]",
"path" : "SubstanceSpecification.relationship.amount[x]",
"short" : "A numeric factor for the relationship, for instance to express that the salt of a substance has some percentage of the active substance in relation to some other",
"definition" : "A numeric factor for the relationship, for instance to express that the salt of a substance has some percentage of the active substance in relation to some other.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceSpecification.relationship.amount[x]",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Quantity"
},
{
"code" : "Range"
},
{
"code" : "Ratio"
},
{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSpecification.relationship.amountRatioLowLimit",
"path" : "SubstanceSpecification.relationship.amountRatioLowLimit",
"short" : "For use when the numeric",
"definition" : "For use when the numeric.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceSpecification.relationship.amountRatioLowLimit",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Ratio"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSpecification.relationship.amountType",
"path" : "SubstanceSpecification.relationship.amountType",
"short" : "An operator for the amount, for example \"average\", \"approximately\", \"less than\"",
"definition" : "An operator for the amount, for example \"average\", \"approximately\", \"less than\".",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceSpecification.relationship.amountType",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSpecification.relationship.source",
"path" : "SubstanceSpecification.relationship.source",
"short" : "Supporting literature",
"definition" : "Supporting literature.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SubstanceSpecification.relationship.source",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/DocumentReference"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSpecification.nucleicAcid",
"path" : "SubstanceSpecification.nucleicAcid",
"short" : "Data items specific to nucleic acids",
"definition" : "Data items specific to nucleic acids.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceSpecification.nucleicAcid",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/SubstanceNucleicAcid"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSpecification.polymer",
"path" : "SubstanceSpecification.polymer",
"short" : "Data items specific to polymers",
"definition" : "Data items specific to polymers.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceSpecification.polymer",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/SubstancePolymer"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSpecification.protein",
"path" : "SubstanceSpecification.protein",
"short" : "Data items specific to proteins",
"definition" : "Data items specific to proteins.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceSpecification.protein",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/SubstanceProtein"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SubstanceSpecification.sourceMaterial",
"path" : "SubstanceSpecification.sourceMaterial",
"short" : "Material or taxonomic/anatomical source for the substance",
"definition" : "Material or taxonomic/anatomical source for the substance.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SubstanceSpecification.sourceMaterial",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/SubstanceSourceMaterial"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
}]
},
"differential" : {
"element" : [{
"id" : "SubstanceSpecification",
"path" : "SubstanceSpecification",
"short" : "The detailed description of a substance, typically at a level beyond what is used for prescribing",
"definition" : "The detailed description of a substance, typically at a level beyond what is used for prescribing.",
"min" : 0,
"max" : "*"
},
{
"id" : "SubstanceSpecification.identifier",
"path" : "SubstanceSpecification.identifier",
"short" : "Identifier by which this substance is known",
"definition" : "Identifier by which this substance is known.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Identifier"
}],
"isSummary" : true
},
{
"id" : "SubstanceSpecification.type",
"path" : "SubstanceSpecification.type",
"short" : "High level categorization, e.g. polymer or nucleic acid",
"definition" : "High level categorization, e.g. polymer or nucleic acid.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "SubstanceSpecification.status",
"path" : "SubstanceSpecification.status",
"short" : "Status of substance within the catalogue e.g. approved",
"definition" : "Status of substance within the catalogue e.g. approved.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "SubstanceSpecification.domain",
"path" : "SubstanceSpecification.domain",
"short" : "If the substance applies to only human or veterinary use",
"definition" : "If the substance applies to only human or veterinary use.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "SubstanceSpecification.description",
"path" : "SubstanceSpecification.description",
"short" : "Textual description of the substance",
"definition" : "Textual description of the substance.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "SubstanceSpecification.source",
"path" : "SubstanceSpecification.source",
"short" : "Supporting literature",
"definition" : "Supporting literature.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/DocumentReference"]
}],
"isSummary" : true
},
{
"id" : "SubstanceSpecification.comment",
"path" : "SubstanceSpecification.comment",
"short" : "Textual comment about this record of a substance",
"definition" : "Textual comment about this record of a substance.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "SubstanceSpecification.moiety",
"path" : "SubstanceSpecification.moiety",
"short" : "Moiety, for structural modifications",
"definition" : "Moiety, for structural modifications.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"isSummary" : true
},
{
"id" : "SubstanceSpecification.moiety.role",
"path" : "SubstanceSpecification.moiety.role",
"short" : "Role that the moiety is playing",
"definition" : "Role that the moiety is playing.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "SubstanceSpecification.moiety.identifier",
"path" : "SubstanceSpecification.moiety.identifier",
"short" : "Identifier by which this moiety substance is known",
"definition" : "Identifier by which this moiety substance is known.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Identifier"
}],
"isSummary" : true
},
{
"id" : "SubstanceSpecification.moiety.name",
"path" : "SubstanceSpecification.moiety.name",
"short" : "Textual name for this moiety substance",
"definition" : "Textual name for this moiety substance.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "SubstanceSpecification.moiety.stereochemistry",
"path" : "SubstanceSpecification.moiety.stereochemistry",
"short" : "Stereochemistry type",
"definition" : "Stereochemistry type.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "SubstanceSpecification.moiety.opticalActivity",
"path" : "SubstanceSpecification.moiety.opticalActivity",
"short" : "Optical activity type",
"definition" : "Optical activity type.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "SubstanceSpecification.moiety.molecularFormula",
"path" : "SubstanceSpecification.moiety.molecularFormula",
"short" : "Molecular formula",
"definition" : "Molecular formula.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "SubstanceSpecification.moiety.amount[x]",
"path" : "SubstanceSpecification.moiety.amount[x]",
"short" : "Quantitative value for this moiety",
"definition" : "Quantitative value for this moiety.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Quantity"
},
{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "SubstanceSpecification.property",
"path" : "SubstanceSpecification.property",
"short" : "General specifications for this substance, including how it is related to other substances",
"definition" : "General specifications for this substance, including how it is related to other substances.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"isSummary" : true
},
{
"id" : "SubstanceSpecification.property.category",
"path" : "SubstanceSpecification.property.category",
"short" : "A category for this property, e.g. Physical, Chemical, Enzymatic",
"definition" : "A category for this property, e.g. Physical, Chemical, Enzymatic.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "SubstanceSpecification.property.code",
"path" : "SubstanceSpecification.property.code",
"short" : "Property type e.g. viscosity, pH, isoelectric point",
"definition" : "Property type e.g. viscosity, pH, isoelectric point.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "SubstanceSpecification.property.parameters",
"path" : "SubstanceSpecification.property.parameters",
"short" : "Parameters that were used in the measurement of a property (e.g. for viscosity: measured at 20C with a pH of 7.1)",
"definition" : "Parameters that were used in the measurement of a property (e.g. for viscosity: measured at 20C with a pH of 7.1).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "SubstanceSpecification.property.definingSubstance[x]",
"path" : "SubstanceSpecification.property.definingSubstance[x]",
"short" : "A substance upon which a defining property depends (e.g. for solubility: in water, in alcohol)",
"definition" : "A substance upon which a defining property depends (e.g. for solubility: in water, in alcohol).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/SubstanceSpecification",
"http://hl7.org/fhir/StructureDefinition/Substance"]
},
{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "SubstanceSpecification.property.amount[x]",
"path" : "SubstanceSpecification.property.amount[x]",
"short" : "Quantitative value for this property",
"definition" : "Quantitative value for this property.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Quantity"
},
{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "SubstanceSpecification.referenceInformation",
"path" : "SubstanceSpecification.referenceInformation",
"short" : "General information detailing this substance",
"definition" : "General information detailing this substance.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/SubstanceReferenceInformation"]
}],
"isSummary" : true
},
{
"id" : "SubstanceSpecification.structure",
"path" : "SubstanceSpecification.structure",
"short" : "Structural information",
"definition" : "Structural information.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "BackboneElement"
}],
"isSummary" : true
},
{
"id" : "SubstanceSpecification.structure.stereochemistry",
"path" : "SubstanceSpecification.structure.stereochemistry",
"short" : "Stereochemistry type",
"definition" : "Stereochemistry type.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "SubstanceSpecification.structure.opticalActivity",
"path" : "SubstanceSpecification.structure.opticalActivity",
"short" : "Optical activity type",
"definition" : "Optical activity type.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "SubstanceSpecification.structure.molecularFormula",
"path" : "SubstanceSpecification.structure.molecularFormula",
"short" : "Molecular formula",
"definition" : "Molecular formula.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "SubstanceSpecification.structure.molecularFormulaByMoiety",
"path" : "SubstanceSpecification.structure.molecularFormulaByMoiety",
"short" : "Specified per moiety according to the Hill system, i.e. first C, then H, then alphabetical, each moiety separated by a dot",
"definition" : "Specified per moiety according to the Hill system, i.e. first C, then H, then alphabetical, each moiety separated by a dot.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "SubstanceSpecification.structure.isotope",
"path" : "SubstanceSpecification.structure.isotope",
"short" : "Applicable for single substances that contain a radionuclide or a non-natural isotopic ratio",
"definition" : "Applicable for single substances that contain a radionuclide or a non-natural isotopic ratio.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"isSummary" : true
},
{
"id" : "SubstanceSpecification.structure.isotope.identifier",
"path" : "SubstanceSpecification.structure.isotope.identifier",
"short" : "Substance identifier for each non-natural or radioisotope",
"definition" : "Substance identifier for each non-natural or radioisotope.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Identifier"
}],
"isSummary" : true
},
{
"id" : "SubstanceSpecification.structure.isotope.name",
"path" : "SubstanceSpecification.structure.isotope.name",
"short" : "Substance name for each non-natural or radioisotope",
"definition" : "Substance name for each non-natural or radioisotope.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "SubstanceSpecification.structure.isotope.substitution",
"path" : "SubstanceSpecification.structure.isotope.substitution",
"short" : "The type of isotopic substitution present in a single substance",
"definition" : "The type of isotopic substitution present in a single substance.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "SubstanceSpecification.structure.isotope.halfLife",
"path" : "SubstanceSpecification.structure.isotope.halfLife",
"short" : "Half life - for a non-natural nuclide",
"definition" : "Half life - for a non-natural nuclide.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Quantity"
}],
"isSummary" : true
},
{
"id" : "SubstanceSpecification.structure.isotope.molecularWeight",
"path" : "SubstanceSpecification.structure.isotope.molecularWeight",
"short" : "The molecular weight or weight range (for proteins, polymers or nucleic acids)",
"definition" : "The molecular weight or weight range (for proteins, polymers or nucleic acids).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "BackboneElement"
}],
"isSummary" : true
},
{
"id" : "SubstanceSpecification.structure.isotope.molecularWeight.method",
"path" : "SubstanceSpecification.structure.isotope.molecularWeight.method",
"short" : "The method by which the molecular weight was determined",
"definition" : "The method by which the molecular weight was determined.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "SubstanceSpecification.structure.isotope.molecularWeight.type",
"path" : "SubstanceSpecification.structure.isotope.molecularWeight.type",
"short" : "Type of molecular weight such as exact, average (also known as. number average), weight average",
"definition" : "Type of molecular weight such as exact, average (also known as. number average), weight average.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "SubstanceSpecification.structure.isotope.molecularWeight.amount",
"path" : "SubstanceSpecification.structure.isotope.molecularWeight.amount",
"short" : "Used to capture quantitative values for a variety of elements. If only limits are given, the arithmetic mean would be the average. If only a single definite value for a given element is given, it would be captured in this field",
"definition" : "Used to capture quantitative values for a variety of elements. If only limits are given, the arithmetic mean would be the average. If only a single definite value for a given element is given, it would be captured in this field.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Quantity"
}],
"isSummary" : true
},
{
"id" : "SubstanceSpecification.structure.molecularWeight",
"path" : "SubstanceSpecification.structure.molecularWeight",
"short" : "The molecular weight or weight range (for proteins, polymers or nucleic acids)",
"definition" : "The molecular weight or weight range (for proteins, polymers or nucleic acids).",
"min" : 0,
"max" : "1",
"contentReference" : "#SubstanceSpecification.structure.isotope.molecularWeight",
"isSummary" : true
},
{
"id" : "SubstanceSpecification.structure.source",
"path" : "SubstanceSpecification.structure.source",
"short" : "Supporting literature",
"definition" : "Supporting literature.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/DocumentReference"]
}],
"isSummary" : true
},
{
"id" : "SubstanceSpecification.structure.representation",
"path" : "SubstanceSpecification.structure.representation",
"short" : "Molecular structural representation",
"definition" : "Molecular structural representation.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"isSummary" : true
},
{
"id" : "SubstanceSpecification.structure.representation.type",
"path" : "SubstanceSpecification.structure.representation.type",
"short" : "The type of structure (e.g. Full, Partial, Representative)",
"definition" : "The type of structure (e.g. Full, Partial, Representative).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "SubstanceSpecification.structure.representation.representation",
"path" : "SubstanceSpecification.structure.representation.representation",
"short" : "The structural representation as text string in a format e.g. InChI, SMILES, MOLFILE, CDX",
"definition" : "The structural representation as text string in a format e.g. InChI, SMILES, MOLFILE, CDX.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "SubstanceSpecification.structure.representation.attachment",
"path" : "SubstanceSpecification.structure.representation.attachment",
"short" : "An attached file with the structural representation",
"definition" : "An attached file with the structural representation.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Attachment"
}],
"isSummary" : true
},
{
"id" : "SubstanceSpecification.code",
"path" : "SubstanceSpecification.code",
"short" : "Codes associated with the substance",
"definition" : "Codes associated with the substance.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"isSummary" : true
},
{
"id" : "SubstanceSpecification.code.code",
"path" : "SubstanceSpecification.code.code",
"short" : "The specific code",
"definition" : "The specific code.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "SubstanceSpecification.code.status",
"path" : "SubstanceSpecification.code.status",
"short" : "Status of the code assignment",
"definition" : "Status of the code assignment.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "SubstanceSpecification.code.statusDate",
"path" : "SubstanceSpecification.code.statusDate",
"short" : "The date at which the code status is changed as part of the terminology maintenance",
"definition" : "The date at which the code status is changed as part of the terminology maintenance.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "dateTime"
}],
"isSummary" : true
},
{
"id" : "SubstanceSpecification.code.comment",
"path" : "SubstanceSpecification.code.comment",
"short" : "Any comment can be provided in this field, if necessary",
"definition" : "Any comment can be provided in this field, if necessary.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "SubstanceSpecification.code.source",
"path" : "SubstanceSpecification.code.source",
"short" : "Supporting literature",
"definition" : "Supporting literature.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/DocumentReference"]
}],
"isSummary" : true
},
{
"id" : "SubstanceSpecification.name",
"path" : "SubstanceSpecification.name",
"short" : "Names applicable to this substance",
"definition" : "Names applicable to this substance.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"isSummary" : true
},
{
"id" : "SubstanceSpecification.name.name",
"path" : "SubstanceSpecification.name.name",
"short" : "The actual name",
"definition" : "The actual name.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "SubstanceSpecification.name.type",
"path" : "SubstanceSpecification.name.type",
"short" : "Name type",
"definition" : "Name type.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "SubstanceSpecification.name.status",
"path" : "SubstanceSpecification.name.status",
"short" : "The status of the name",
"definition" : "The status of the name.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "SubstanceSpecification.name.preferred",
"path" : "SubstanceSpecification.name.preferred",
"short" : "If this is the preferred name for this substance",
"definition" : "If this is the preferred name for this substance.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "boolean"
}],
"isSummary" : true
},
{
"id" : "SubstanceSpecification.name.language",
"path" : "SubstanceSpecification.name.language",
"short" : "Language of the name",
"definition" : "Language of the name.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "SubstanceSpecification.name.domain",
"path" : "SubstanceSpecification.name.domain",
"short" : "The use context of this name for example if there is a different name a drug active ingredient as opposed to a food colour additive",
"definition" : "The use context of this name for example if there is a different name a drug active ingredient as opposed to a food colour additive.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "SubstanceSpecification.name.jurisdiction",
"path" : "SubstanceSpecification.name.jurisdiction",
"short" : "The jurisdiction where this name applies",
"definition" : "The jurisdiction where this name applies.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "SubstanceSpecification.name.synonym",
"path" : "SubstanceSpecification.name.synonym",
"short" : "A synonym of this name",
"definition" : "A synonym of this name.",
"min" : 0,
"max" : "*",
"contentReference" : "#SubstanceSpecification.name",
"isSummary" : true
},
{
"id" : "SubstanceSpecification.name.translation",
"path" : "SubstanceSpecification.name.translation",
"short" : "A translation for this name",
"definition" : "A translation for this name.",
"min" : 0,
"max" : "*",
"contentReference" : "#SubstanceSpecification.name",
"isSummary" : true
},
{
"id" : "SubstanceSpecification.name.official",
"path" : "SubstanceSpecification.name.official",
"short" : "Details of the official nature of this name",
"definition" : "Details of the official nature of this name.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"isSummary" : true
},
{
"id" : "SubstanceSpecification.name.official.authority",
"path" : "SubstanceSpecification.name.official.authority",
"short" : "Which authority uses this official name",
"definition" : "Which authority uses this official name.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "SubstanceSpecification.name.official.status",
"path" : "SubstanceSpecification.name.official.status",
"short" : "The status of the official name",
"definition" : "The status of the official name.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "SubstanceSpecification.name.official.date",
"path" : "SubstanceSpecification.name.official.date",
"short" : "Date of official name change",
"definition" : "Date of official name change.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "dateTime"
}],
"isSummary" : true
},
{
"id" : "SubstanceSpecification.name.source",
"path" : "SubstanceSpecification.name.source",
"short" : "Supporting literature",
"definition" : "Supporting literature.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/DocumentReference"]
}],
"isSummary" : true
},
{
"id" : "SubstanceSpecification.molecularWeight",
"path" : "SubstanceSpecification.molecularWeight",
"short" : "The molecular weight or weight range (for proteins, polymers or nucleic acids)",
"definition" : "The molecular weight or weight range (for proteins, polymers or nucleic acids).",
"min" : 0,
"max" : "*",
"contentReference" : "#SubstanceSpecification.structure.isotope.molecularWeight",
"isSummary" : true
},
{
"id" : "SubstanceSpecification.relationship",
"path" : "SubstanceSpecification.relationship",
"short" : "A link between this substance and another, with details of the relationship",
"definition" : "A link between this substance and another, with details of the relationship.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"isSummary" : true
},
{
"id" : "SubstanceSpecification.relationship.substance[x]",
"path" : "SubstanceSpecification.relationship.substance[x]",
"short" : "A pointer to another substance, as a resource or just a representational code",
"definition" : "A pointer to another substance, as a resource or just a representational code.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/SubstanceSpecification"]
},
{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "SubstanceSpecification.relationship.relationship",
"path" : "SubstanceSpecification.relationship.relationship",
"short" : "For example \"salt to parent\", \"active moiety\", \"starting material\"",
"definition" : "For example \"salt to parent\", \"active moiety\", \"starting material\".",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "SubstanceSpecification.relationship.isDefining",
"path" : "SubstanceSpecification.relationship.isDefining",
"short" : "For example where an enzyme strongly bonds with a particular substance, this is a defining relationship for that enzyme, out of several possible substance relationships",
"definition" : "For example where an enzyme strongly bonds with a particular substance, this is a defining relationship for that enzyme, out of several possible substance relationships.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "boolean"
}],
"isSummary" : true
},
{
"id" : "SubstanceSpecification.relationship.amount[x]",
"path" : "SubstanceSpecification.relationship.amount[x]",
"short" : "A numeric factor for the relationship, for instance to express that the salt of a substance has some percentage of the active substance in relation to some other",
"definition" : "A numeric factor for the relationship, for instance to express that the salt of a substance has some percentage of the active substance in relation to some other.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Quantity"
},
{
"code" : "Range"
},
{
"code" : "Ratio"
},
{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "SubstanceSpecification.relationship.amountRatioLowLimit",
"path" : "SubstanceSpecification.relationship.amountRatioLowLimit",
"short" : "For use when the numeric",
"definition" : "For use when the numeric.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Ratio"
}],
"isSummary" : true
},
{
"id" : "SubstanceSpecification.relationship.amountType",
"path" : "SubstanceSpecification.relationship.amountType",
"short" : "An operator for the amount, for example \"average\", \"approximately\", \"less than\"",
"definition" : "An operator for the amount, for example \"average\", \"approximately\", \"less than\".",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true
},
{
"id" : "SubstanceSpecification.relationship.source",
"path" : "SubstanceSpecification.relationship.source",
"short" : "Supporting literature",
"definition" : "Supporting literature.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/DocumentReference"]
}],
"isSummary" : true
},
{
"id" : "SubstanceSpecification.nucleicAcid",
"path" : "SubstanceSpecification.nucleicAcid",
"short" : "Data items specific to nucleic acids",
"definition" : "Data items specific to nucleic acids.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/SubstanceNucleicAcid"]
}],
"isSummary" : true
},
{
"id" : "SubstanceSpecification.polymer",
"path" : "SubstanceSpecification.polymer",
"short" : "Data items specific to polymers",
"definition" : "Data items specific to polymers.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/SubstancePolymer"]
}],
"isSummary" : true
},
{
"id" : "SubstanceSpecification.protein",
"path" : "SubstanceSpecification.protein",
"short" : "Data items specific to proteins",
"definition" : "Data items specific to proteins.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/SubstanceProtein"]
}],
"isSummary" : true
},
{
"id" : "SubstanceSpecification.sourceMaterial",
"path" : "SubstanceSpecification.sourceMaterial",
"short" : "Material or taxonomic/anatomical source for the substance",
"definition" : "Material or taxonomic/anatomical source for the substance.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/SubstanceSourceMaterial"]
}],
"isSummary" : true
}]
}
}
},
{
"fullUrl" : "http://hl7.org/fhir/StructureDefinition/SupplyDelivery",
"resource" : {
"resourceType" : "StructureDefinition",
"id" : "SupplyDelivery",
"meta" : {
"lastUpdated" : "2019-11-01T09:29:23.356+11:00"
},
"text" : {
"status" : "generated",
"div" : "Name Flags Card. Type Description & Constraints SupplyDelivery TU DomainResource Delivery of bulk Supplies
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension identifier 0..* Identifier External identifier
basedOn Σ 0..* Reference(SupplyRequest) Fulfills plan, proposal or order
partOf Σ 0..* Reference(SupplyDelivery | Contract) Part of referenced event
status ?!Σ 0..1 code in-progress | completed | abandoned | entered-in-error
SupplyDeliveryStatus (Required) patient 0..1 Reference(Patient) Patient for whom the item is supplied type 0..1 CodeableConcept Category of dispense event
Supply Item Type (Required) suppliedItem 0..1 BackboneElement The item that is delivered or supplied quantity 0..1 SimpleQuantity Amount dispensed item[x] 0..1 Medication, Substance, or Device supplied
SNOMED CT Supply Item (Example) itemCodeableConcept CodeableConcept itemReference Reference(Medication | Substance | Device) occurrence[x] Σ 0..1 When event occurred occurrenceDateTime dateTime occurrencePeriod Period occurrenceTiming Timing supplier 0..1 Reference(Practitioner | PractitionerRole | Organization) Dispenser destination 0..1 Reference(Location) Where the Supply was sent receiver 0..* Reference(Practitioner | PractitionerRole) Who collected the Supply
Documentation for this format
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Clinical.Request & Response"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 1
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "patient"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "oo"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/SupplyDelivery",
"version" : "4.0.1",
"name" : "SupplyDelivery",
"status" : "draft",
"date" : "2019-11-01T09:29:23+11:00",
"publisher" : "Health Level Seven International (Orders and Observations)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/orders/index.cfm"
}]
}],
"description" : "Record of delivery of what is supplied.",
"fhirVersion" : "4.0.1",
"mapping" : [{
"identity" : "workflow",
"uri" : "http://hl7.org/fhir/workflow",
"name" : "Workflow Pattern"
},
{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
},
{
"identity" : "v2",
"uri" : "http://hl7.org/v2",
"name" : "HL7 v2 Mapping"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/fivews",
"name" : "FiveWs Pattern Mapping"
}],
"kind" : "resource",
"abstract" : false,
"type" : "SupplyDelivery",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "SupplyDelivery",
"path" : "SupplyDelivery",
"short" : "Delivery of bulk Supplies",
"definition" : "Record of delivery of what is supplied.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SupplyDelivery",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "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",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.`div`.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "workflow",
"map" : "Event"
},
{
"identity" : "rim",
"map" : "Supply[moodCode=RQO]"
}]
},
{
"id" : "SupplyDelivery.id",
"path" : "SupplyDelivery.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SupplyDelivery.meta",
"path" : "SupplyDelivery.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SupplyDelivery.implicitRules",
"path" : "SupplyDelivery.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "SupplyDelivery.language",
"path" : "SupplyDelivery.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "SupplyDelivery.text",
"path" : "SupplyDelivery.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "SupplyDelivery.contained",
"path" : "SupplyDelivery.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "SupplyDelivery.extension",
"path" : "SupplyDelivery.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "SupplyDelivery.modifierExtension",
"path" : "SupplyDelivery.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "SupplyDelivery.identifier",
"path" : "SupplyDelivery.identifier",
"short" : "External identifier",
"definition" : "Identifier for the supply delivery event that is used to identify it across multiple disparate systems.",
"comment" : "This identifier is typically assigned by the dispenser, and may be used to reference the delivery when exchanging information about it with other systems.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SupplyDelivery.identifier",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Identifier"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.identifier"
},
{
"identity" : "rim",
"map" : ".id"
}]
},
{
"id" : "SupplyDelivery.basedOn",
"path" : "SupplyDelivery.basedOn",
"short" : "Fulfills plan, proposal or order",
"definition" : "A plan, proposal or order that is fulfilled in whole or in part by this event.",
"requirements" : "Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SupplyDelivery.basedOn",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/SupplyRequest"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.basedOn"
},
{
"identity" : "v2",
"map" : "ORC in proximity to EVN segment"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=FLFS].target"
}]
},
{
"id" : "SupplyDelivery.partOf",
"path" : "SupplyDelivery.partOf",
"short" : "Part of referenced event",
"definition" : "A larger event of which this particular event is a component or step.",
"comment" : "Not to be used to link an event to an Encounter - use Event.context for that.\r\r[The allowed reference resources may be adjusted as appropriate for the event resource].",
"requirements" : "E.g. Drug administration as part of a procedure, procedure as part of observation, etc.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SupplyDelivery.partOf",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/SupplyDelivery",
"http://hl7.org/fhir/StructureDefinition/Contract"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.partOf"
},
{
"identity" : "v2",
"map" : "Varies by domain"
},
{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=COMP].source[moodCode=EVN]"
}]
},
{
"id" : "SupplyDelivery.status",
"path" : "SupplyDelivery.status",
"short" : "in-progress | completed | abandoned | entered-in-error",
"definition" : "A code specifying the state of the dispense event.",
"comment" : "This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SupplyDelivery.status",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SupplyDeliveryStatus"
}],
"strength" : "required",
"description" : "Status of the supply delivery.",
"valueSet" : "http://hl7.org/fhir/ValueSet/supplydelivery-status|4.0.1"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.status"
},
{
"identity" : "rim",
"map" : ".statusCode, also existence of fulfillment events"
}]
},
{
"id" : "SupplyDelivery.patient",
"path" : "SupplyDelivery.patient",
"short" : "Patient for whom the item is supplied",
"definition" : "A link to a resource representing the person whom the delivered item is for.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SupplyDelivery.patient",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.subject"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=SBJ].role"
}]
},
{
"id" : "SupplyDelivery.type",
"path" : "SupplyDelivery.type",
"short" : "Category of dispense event",
"definition" : "Indicates the type of dispensing event that is performed. Examples include: Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SupplyDelivery.type",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SupplyDeliveryType"
}],
"strength" : "required",
"description" : "The type of supply dispense.",
"valueSet" : "http://hl7.org/fhir/ValueSet/supplydelivery-type|4.0.1"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.code"
},
{
"identity" : "rim",
"map" : ".code"
}]
},
{
"id" : "SupplyDelivery.suppliedItem",
"path" : "SupplyDelivery.suppliedItem",
"short" : "The item that is delivered or supplied",
"definition" : "The item that is being delivered or has been supplied.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SupplyDelivery.suppliedItem",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".participation[typeCode=PRD].role"
}]
},
{
"id" : "SupplyDelivery.suppliedItem.id",
"path" : "SupplyDelivery.suppliedItem.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "SupplyDelivery.suppliedItem.extension",
"path" : "SupplyDelivery.suppliedItem.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "SupplyDelivery.suppliedItem.modifierExtension",
"path" : "SupplyDelivery.suppliedItem.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "SupplyDelivery.suppliedItem.quantity",
"path" : "SupplyDelivery.suppliedItem.quantity",
"short" : "Amount dispensed",
"definition" : "The amount of supply that has been dispensed. Includes unit of measure.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SupplyDelivery.suppliedItem.quantity",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Quantity",
"profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".quantity"
}]
},
{
"id" : "SupplyDelivery.suppliedItem.item[x]",
"path" : "SupplyDelivery.suppliedItem.item[x]",
"short" : "Medication, Substance, or Device supplied",
"definition" : "Identifies the medication, substance or device being dispensed. This is either a link to a resource representing the details of the item or a code that identifies the item from a known list.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SupplyDelivery.suppliedItem.item[x]",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
},
{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Medication",
"http://hl7.org/fhir/StructureDefinition/Substance",
"http://hl7.org/fhir/StructureDefinition/Device"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SupplyDeliveryItem"
}],
"strength" : "example",
"description" : "The item that was delivered.",
"valueSet" : "http://hl7.org/fhir/ValueSet/supply-item"
},
"mapping" : [{
"identity" : "rim",
"map" : ".participation[typeCode=PRD].role"
}]
},
{
"id" : "SupplyDelivery.occurrence[x]",
"path" : "SupplyDelivery.occurrence[x]",
"short" : "When event occurred",
"definition" : "The date or time(s) the activity occurred.",
"comment" : "[The list of types may be constrained as appropriate for the type of event].",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SupplyDelivery.occurrence[x]",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
},
{
"code" : "Period"
},
{
"code" : "Timing"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.occurrence[x]"
},
{
"identity" : "w5",
"map" : "FiveWs.done[x]"
},
{
"identity" : "v2",
"map" : "Varies by domain"
},
{
"identity" : "rim",
"map" : ".effectiveTime"
}]
},
{
"id" : "SupplyDelivery.supplier",
"path" : "SupplyDelivery.supplier",
"short" : "Dispenser",
"definition" : "The individual responsible for dispensing the medication, supplier or device.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SupplyDelivery.supplier",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.performer"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=PFM].role"
}]
},
{
"id" : "SupplyDelivery.destination",
"path" : "SupplyDelivery.destination",
"short" : "Where the Supply was sent",
"definition" : "Identification of the facility/location where the Supply was shipped to, as part of the dispense event.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SupplyDelivery.destination",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Location"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".participation[typeCode=DST].role"
}]
},
{
"id" : "SupplyDelivery.receiver",
"path" : "SupplyDelivery.receiver",
"short" : "Who collected the Supply",
"definition" : "Identifies the person who picked up the Supply.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SupplyDelivery.receiver",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".participation[typeCode=RCV].role"
}]
}]
},
"differential" : {
"element" : [{
"id" : "SupplyDelivery",
"path" : "SupplyDelivery",
"short" : "Delivery of bulk Supplies",
"definition" : "Record of delivery of what is supplied.",
"min" : 0,
"max" : "*",
"mapping" : [{
"identity" : "workflow",
"map" : "Event"
},
{
"identity" : "rim",
"map" : "Supply[moodCode=RQO]"
}]
},
{
"id" : "SupplyDelivery.identifier",
"path" : "SupplyDelivery.identifier",
"short" : "External identifier",
"definition" : "Identifier for the supply delivery event that is used to identify it across multiple disparate systems.",
"comment" : "This identifier is typically assigned by the dispenser, and may be used to reference the delivery when exchanging information about it with other systems.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Identifier"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Event.identifier"
},
{
"identity" : "rim",
"map" : ".id"
}]
},
{
"id" : "SupplyDelivery.basedOn",
"path" : "SupplyDelivery.basedOn",
"short" : "Fulfills plan, proposal or order",
"definition" : "A plan, proposal or order that is fulfilled in whole or in part by this event.",
"requirements" : "Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/SupplyRequest"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.basedOn"
},
{
"identity" : "v2",
"map" : "ORC in proximity to EVN segment"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=FLFS].target"
}]
},
{
"id" : "SupplyDelivery.partOf",
"path" : "SupplyDelivery.partOf",
"short" : "Part of referenced event",
"definition" : "A larger event of which this particular event is a component or step.",
"comment" : "Not to be used to link an event to an Encounter - use Event.context for that.\r\r[The allowed reference resources may be adjusted as appropriate for the event resource].",
"requirements" : "E.g. Drug administration as part of a procedure, procedure as part of observation, etc.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/SupplyDelivery",
"http://hl7.org/fhir/StructureDefinition/Contract"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.partOf"
},
{
"identity" : "v2",
"map" : "Varies by domain"
},
{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=COMP].source[moodCode=EVN]"
}]
},
{
"id" : "SupplyDelivery.status",
"path" : "SupplyDelivery.status",
"short" : "in-progress | completed | abandoned | entered-in-error",
"definition" : "A code specifying the state of the dispense event.",
"comment" : "This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isModifier" : true,
"isModifierReason" : "This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SupplyDeliveryStatus"
}],
"strength" : "required",
"description" : "Status of the supply delivery.",
"valueSet" : "http://hl7.org/fhir/ValueSet/supplydelivery-status|4.0.1"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.status"
},
{
"identity" : "rim",
"map" : ".statusCode, also existence of fulfillment events"
}]
},
{
"id" : "SupplyDelivery.patient",
"path" : "SupplyDelivery.patient",
"short" : "Patient for whom the item is supplied",
"definition" : "A link to a resource representing the person whom the delivered item is for.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient"]
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Event.subject"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=SBJ].role"
}]
},
{
"id" : "SupplyDelivery.type",
"path" : "SupplyDelivery.type",
"short" : "Category of dispense event",
"definition" : "Indicates the type of dispensing event that is performed. Examples include: Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SupplyDeliveryType"
}],
"strength" : "required",
"description" : "The type of supply dispense.",
"valueSet" : "http://hl7.org/fhir/ValueSet/supplydelivery-type|4.0.1"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.code"
},
{
"identity" : "rim",
"map" : ".code"
}]
},
{
"id" : "SupplyDelivery.suppliedItem",
"path" : "SupplyDelivery.suppliedItem",
"short" : "The item that is delivered or supplied",
"definition" : "The item that is being delivered or has been supplied.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "BackboneElement"
}],
"mapping" : [{
"identity" : "rim",
"map" : ".participation[typeCode=PRD].role"
}]
},
{
"id" : "SupplyDelivery.suppliedItem.quantity",
"path" : "SupplyDelivery.suppliedItem.quantity",
"short" : "Amount dispensed",
"definition" : "The amount of supply that has been dispensed. Includes unit of measure.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Quantity",
"profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
}],
"mapping" : [{
"identity" : "rim",
"map" : ".quantity"
}]
},
{
"id" : "SupplyDelivery.suppliedItem.item[x]",
"path" : "SupplyDelivery.suppliedItem.item[x]",
"short" : "Medication, Substance, or Device supplied",
"definition" : "Identifies the medication, substance or device being dispensed. This is either a link to a resource representing the details of the item or a code that identifies the item from a known list.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
},
{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Medication",
"http://hl7.org/fhir/StructureDefinition/Substance",
"http://hl7.org/fhir/StructureDefinition/Device"]
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SupplyDeliveryItem"
}],
"strength" : "example",
"description" : "The item that was delivered.",
"valueSet" : "http://hl7.org/fhir/ValueSet/supply-item"
},
"mapping" : [{
"identity" : "rim",
"map" : ".participation[typeCode=PRD].role"
}]
},
{
"id" : "SupplyDelivery.occurrence[x]",
"path" : "SupplyDelivery.occurrence[x]",
"short" : "When event occurred",
"definition" : "The date or time(s) the activity occurred.",
"comment" : "[The list of types may be constrained as appropriate for the type of event].",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "dateTime"
},
{
"code" : "Period"
},
{
"code" : "Timing"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.occurrence[x]"
},
{
"identity" : "w5",
"map" : "FiveWs.done[x]"
},
{
"identity" : "v2",
"map" : "Varies by domain"
},
{
"identity" : "rim",
"map" : ".effectiveTime"
}]
},
{
"id" : "SupplyDelivery.supplier",
"path" : "SupplyDelivery.supplier",
"short" : "Dispenser",
"definition" : "The individual responsible for dispensing the medication, supplier or device.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Event.performer"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=PFM].role"
}]
},
{
"id" : "SupplyDelivery.destination",
"path" : "SupplyDelivery.destination",
"short" : "Where the Supply was sent",
"definition" : "Identification of the facility/location where the Supply was shipped to, as part of the dispense event.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Location"]
}],
"mapping" : [{
"identity" : "rim",
"map" : ".participation[typeCode=DST].role"
}]
},
{
"id" : "SupplyDelivery.receiver",
"path" : "SupplyDelivery.receiver",
"short" : "Who collected the Supply",
"definition" : "Identifies the person who picked up the Supply.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole"]
}],
"mapping" : [{
"identity" : "rim",
"map" : ".participation[typeCode=RCV].role"
}]
}]
}
}
},
{
"fullUrl" : "http://hl7.org/fhir/StructureDefinition/SupplyRequest",
"resource" : {
"resourceType" : "StructureDefinition",
"id" : "SupplyRequest",
"meta" : {
"lastUpdated" : "2019-11-01T09:29:23.356+11:00"
},
"text" : {
"status" : "generated",
"div" : "Name Flags Card. Type Description & Constraints SupplyRequest TU DomainResource Request for a medication, substance or device
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension identifier Σ 0..* Identifier Business Identifier for SupplyRequest
status ?!Σ 0..1 code draft | active | suspended +
SupplyRequestStatus (Required) category Σ 0..1 CodeableConcept The kind of supply (central, non-stock, etc.)
Supply Type (Example) priority Σ 0..1 code routine | urgent | asap | stat
Request priority (Required) item[x] Σ 1..1 Medication, Substance, or Device requested to be supplied
SNOMED CT Supply Item (Example) itemCodeableConcept CodeableConcept itemReference Reference(Medication | Substance | Device) quantity Σ 1..1 Quantity The requested amount of the item indicated parameter 0..* BackboneElement Ordered item details
code 0..1 CodeableConcept Item detail value[x] 0..1 Value of detail valueCodeableConcept CodeableConcept valueQuantity Quantity valueRange Range valueBoolean boolean occurrence[x] Σ 0..1 When the request should be fulfilled occurrenceDateTime dateTime occurrencePeriod Period occurrenceTiming Timing authoredOn Σ 0..1 dateTime When the request was made requester Σ 0..1 Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) Individual making the request supplier Σ 0..* Reference(Organization | HealthcareService) Who is intended to fulfill the request
reasonCode 0..* CodeableConcept The reason why the supply item was requested
SupplyRequestReason (Example)
reasonReference 0..* Reference(Condition | Observation | DiagnosticReport | DocumentReference) The reason why the supply item was requested
deliverFrom 0..1 Reference(Organization | Location) The origin of the supply deliverTo 0..1 Reference(Organization | Location | Patient) The destination of the supply
Documentation for this format
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Clinical.Request & Response"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 1
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "patient"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "oo"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/SupplyRequest",
"version" : "4.0.1",
"name" : "SupplyRequest",
"status" : "draft",
"date" : "2019-11-01T09:29:23+11:00",
"publisher" : "Health Level Seven International (Orders and Observations)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/orders/index.cfm"
}]
}],
"description" : "A record of a request for a medication, substance or device used in the healthcare setting.",
"fhirVersion" : "4.0.1",
"mapping" : [{
"identity" : "workflow",
"uri" : "http://hl7.org/fhir/workflow",
"name" : "Workflow Pattern"
},
{
"identity" : "v2",
"uri" : "http://hl7.org/v2",
"name" : "HL7 v2 Mapping"
},
{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/fivews",
"name" : "FiveWs Pattern Mapping"
}],
"kind" : "resource",
"abstract" : false,
"type" : "SupplyRequest",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "SupplyRequest",
"path" : "SupplyRequest",
"short" : "Request for a medication, substance or device",
"definition" : "A record of a request for a medication, substance or device used in the healthcare setting.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SupplyRequest",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "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",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.`div`.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "workflow",
"map" : "Request"
},
{
"identity" : "v2",
"map" : "ORC"
},
{
"identity" : "rim",
"map" : "Act[moodCode<=INT]"
}]
},
{
"id" : "SupplyRequest.id",
"path" : "SupplyRequest.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SupplyRequest.meta",
"path" : "SupplyRequest.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "SupplyRequest.implicitRules",
"path" : "SupplyRequest.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "SupplyRequest.language",
"path" : "SupplyRequest.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "SupplyRequest.text",
"path" : "SupplyRequest.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "SupplyRequest.contained",
"path" : "SupplyRequest.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "SupplyRequest.extension",
"path" : "SupplyRequest.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "SupplyRequest.modifierExtension",
"path" : "SupplyRequest.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "SupplyRequest.identifier",
"path" : "SupplyRequest.identifier",
"short" : "Business Identifier for SupplyRequest",
"definition" : "Business identifiers assigned to this SupplyRequest by the author and/or other systems. These identifiers remain constant as the resource is updated and propagates from server to server.",
"comment" : "The identifier.type element is used to distinguish between the identifiers assigned by the requester/placer and the performer/filler.",
"requirements" : "Allows identification of the request as it is known by various participating systems and in a way that remains consistent across servers.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SupplyRequest.identifier",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Identifier"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.identifier"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "v2",
"map" : "ORC.2, ORC.3"
},
{
"identity" : "rim",
"map" : ".identifier"
}]
},
{
"id" : "SupplyRequest.status",
"path" : "SupplyRequest.status",
"short" : "draft | active | suspended +",
"definition" : "Status of the supply request.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SupplyRequest.status",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SupplyRequestStatus"
}],
"strength" : "required",
"description" : "Status of the supply request.",
"valueSet" : "http://hl7.org/fhir/ValueSet/supplyrequest-status|4.0.1"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.status"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
},
{
"identity" : "v2",
"map" : "ORC.5"
},
{
"identity" : "rim",
"map" : ".status"
}]
},
{
"id" : "SupplyRequest.category",
"path" : "SupplyRequest.category",
"short" : "The kind of supply (central, non-stock, etc.)",
"definition" : "Category of supply, e.g. central, non-stock, etc. This is used to support work flows associated with the supply process.",
"alias" : ["kind"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "SupplyRequest.category",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SupplyRequestKind"
}],
"strength" : "example",
"description" : "Category of supply request.",
"valueSet" : "http://hl7.org/fhir/ValueSet/supplyrequest-kind"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.class"
},
{
"identity" : "v2",
"map" : "N/A"
},
{
"identity" : "rim",
"map" : ".code"
}]
},
{
"id" : "SupplyRequest.priority",
"path" : "SupplyRequest.priority",
"short" : "routine | urgent | asap | stat",
"definition" : "Indicates how quickly this SupplyRequest should be addressed with respect to other requests.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SupplyRequest.priority",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"meaningWhenMissing" : "If missing, this task should be performed with normal priority",
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "RequestPriority"
}],
"strength" : "required",
"description" : "Identifies the level of importance to be assigned to actioning the request.",
"valueSet" : "http://hl7.org/fhir/ValueSet/request-priority|4.0.1"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.priority"
},
{
"identity" : "w5",
"map" : "FiveWs.grade"
},
{
"identity" : "v2",
"map" : "TQ1.9"
},
{
"identity" : "rim",
"map" : ".priorityCode"
}]
},
{
"id" : "SupplyRequest.item[x]",
"path" : "SupplyRequest.item[x]",
"short" : "Medication, Substance, or Device requested to be supplied",
"definition" : "The item that is requested to be supplied. This is either a link to a resource representing the details of the item or a code that identifies the item from a known list.",
"comment" : "Note that there's a difference between a prescription - an instruction to take a medication, along with a (sometimes) implicit supply, and an explicit request to supply, with no explicit instructions.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "SupplyRequest.item[x]",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
},
{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Medication",
"http://hl7.org/fhir/StructureDefinition/Substance",
"http://hl7.org/fhir/StructureDefinition/Device"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SupplyRequestItem"
}],
"strength" : "example",
"description" : "The item that was requested.",
"valueSet" : "http://hl7.org/fhir/ValueSet/supply-item"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.code"
},
{
"identity" : "rim",
"map" : ".code"
}]
},
{
"id" : "SupplyRequest.quantity",
"path" : "SupplyRequest.quantity",
"short" : "The requested amount of the item indicated",
"definition" : "The amount that is being ordered of the indicated item.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "SupplyRequest.quantity",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "Quantity"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : ".quantity"
}]
},
{
"id" : "SupplyRequest.parameter",
"path" : "SupplyRequest.parameter",
"short" : "Ordered item details",
"definition" : "Specific parameters for the ordered item. For example, the size of the indicated item.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SupplyRequest.parameter",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.what[x]"
},
{
"identity" : "v2",
"map" : "Varies by domain"
}]
},
{
"id" : "SupplyRequest.parameter.id",
"path" : "SupplyRequest.parameter.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "SupplyRequest.parameter.extension",
"path" : "SupplyRequest.parameter.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "SupplyRequest.parameter.modifierExtension",
"path" : "SupplyRequest.parameter.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "SupplyRequest.parameter.code",
"path" : "SupplyRequest.parameter.code",
"short" : "Item detail",
"definition" : "A code or string that identifies the device detail being asserted.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SupplyRequest.parameter.code",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ParameterCode"
}],
"strength" : "example",
"description" : "A code that identifies the device detail."
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.what[x]"
},
{
"identity" : "v2",
"map" : "Varies by domain"
},
{
"identity" : "rim",
"map" : ".code"
}]
},
{
"id" : "SupplyRequest.parameter.value[x]",
"path" : "SupplyRequest.parameter.value[x]",
"short" : "Value of detail",
"definition" : "The value of the device detail.",
"comment" : "Range means device should have a value that falls somewhere within the specified range.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SupplyRequest.parameter.value[x]",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
},
{
"code" : "Quantity"
},
{
"code" : "Range"
},
{
"code" : "boolean"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.what[x]"
},
{
"identity" : "v2",
"map" : "Varies by domain"
},
{
"identity" : "rim",
"map" : ".code"
}]
},
{
"id" : "SupplyRequest.occurrence[x]",
"path" : "SupplyRequest.occurrence[x]",
"short" : "When the request should be fulfilled",
"definition" : "When the request should be fulfilled.",
"alias" : ["when",
"timing"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "SupplyRequest.occurrence[x]",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
},
{
"code" : "Period"
},
{
"code" : "Timing"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.occurrence[x]"
},
{
"identity" : "w5",
"map" : "FiveWs.planned"
},
{
"identity" : "v2",
"map" : "Accompanying TQ1/TQ2 segments"
},
{
"identity" : "rim",
"map" : ".effectiveTime"
}]
},
{
"id" : "SupplyRequest.authoredOn",
"path" : "SupplyRequest.authoredOn",
"short" : "When the request was made",
"definition" : "When the request was made.",
"alias" : ["date",
"createdOn",
"signedOn"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "SupplyRequest.authoredOn",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.authoredOn"
},
{
"identity" : "w5",
"map" : "FiveWs.recorded"
},
{
"identity" : "v2",
"map" : "ORC.9"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=AUT].time"
}]
},
{
"id" : "SupplyRequest.requester",
"path" : "SupplyRequest.requester",
"short" : "Individual making the request",
"definition" : "The device, practitioner, etc. who initiated the request.",
"alias" : ["author",
"source"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "SupplyRequest.requester",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Organization",
"http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson",
"http://hl7.org/fhir/StructureDefinition/Device"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.requester"
},
{
"identity" : "w5",
"map" : "FiveWs.author"
},
{
"identity" : "v2",
"map" : "ORC.12"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=AUT].role"
}]
},
{
"id" : "SupplyRequest.supplier",
"path" : "SupplyRequest.supplier",
"short" : "Who is intended to fulfill the request",
"definition" : "Who is intended to fulfill the request.",
"alias" : ["performer"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "SupplyRequest.supplier",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization",
"http://hl7.org/fhir/StructureDefinition/HealthcareService"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.performer"
},
{
"identity" : "w5",
"map" : "FiveWs.actor"
},
{
"identity" : "v2",
"map" : "PRT"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]"
}]
},
{
"id" : "SupplyRequest.reasonCode",
"path" : "SupplyRequest.reasonCode",
"short" : "The reason why the supply item was requested",
"definition" : "The reason why the supply item was requested.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SupplyRequest.reasonCode",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SupplyRequestReason"
}],
"strength" : "example",
"description" : "The reason why the supply item was requested.",
"valueSet" : "http://hl7.org/fhir/ValueSet/supplyrequest-reason"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.reasonCode"
},
{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "v2",
"map" : "ORC.16"
},
{
"identity" : "rim",
"map" : ".reasonCode"
}]
},
{
"id" : "SupplyRequest.reasonReference",
"path" : "SupplyRequest.reasonReference",
"short" : "The reason why the supply item was requested",
"definition" : "The reason why the supply item was requested.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "SupplyRequest.reasonReference",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Condition",
"http://hl7.org/fhir/StructureDefinition/Observation",
"http://hl7.org/fhir/StructureDefinition/DiagnosticReport",
"http://hl7.org/fhir/StructureDefinition/DocumentReference"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.reasonReference"
},
{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "v2",
"map" : "ORC.16"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=RSON].target"
}]
},
{
"id" : "SupplyRequest.deliverFrom",
"path" : "SupplyRequest.deliverFrom",
"short" : "The origin of the supply",
"definition" : "Where the supply is expected to come from.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SupplyRequest.deliverFrom",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization",
"http://hl7.org/fhir/StructureDefinition/Location"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "PRT"
},
{
"identity" : "rim",
"map" : ".participation"
}]
},
{
"id" : "SupplyRequest.deliverTo",
"path" : "SupplyRequest.deliverTo",
"short" : "The destination of the supply",
"definition" : "Where the supply is destined to go.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "SupplyRequest.deliverTo",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization",
"http://hl7.org/fhir/StructureDefinition/Location",
"http://hl7.org/fhir/StructureDefinition/Patient"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "PRT"
},
{
"identity" : "rim",
"map" : ".participation"
}]
}]
},
"differential" : {
"element" : [{
"id" : "SupplyRequest",
"path" : "SupplyRequest",
"short" : "Request for a medication, substance or device",
"definition" : "A record of a request for a medication, substance or device used in the healthcare setting.",
"min" : 0,
"max" : "*",
"mapping" : [{
"identity" : "workflow",
"map" : "Request"
},
{
"identity" : "v2",
"map" : "ORC"
},
{
"identity" : "rim",
"map" : "Act[moodCode<=INT]"
}]
},
{
"id" : "SupplyRequest.identifier",
"path" : "SupplyRequest.identifier",
"short" : "Business Identifier for SupplyRequest",
"definition" : "Business identifiers assigned to this SupplyRequest by the author and/or other systems. These identifiers remain constant as the resource is updated and propagates from server to server.",
"comment" : "The identifier.type element is used to distinguish between the identifiers assigned by the requester/placer and the performer/filler.",
"requirements" : "Allows identification of the request as it is known by various participating systems and in a way that remains consistent across servers.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Identifier"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.identifier"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "v2",
"map" : "ORC.2, ORC.3"
},
{
"identity" : "rim",
"map" : ".identifier"
}]
},
{
"id" : "SupplyRequest.status",
"path" : "SupplyRequest.status",
"short" : "draft | active | suspended +",
"definition" : "Status of the supply request.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SupplyRequestStatus"
}],
"strength" : "required",
"description" : "Status of the supply request.",
"valueSet" : "http://hl7.org/fhir/ValueSet/supplyrequest-status|4.0.1"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.status"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
},
{
"identity" : "v2",
"map" : "ORC.5"
},
{
"identity" : "rim",
"map" : ".status"
}]
},
{
"id" : "SupplyRequest.category",
"path" : "SupplyRequest.category",
"short" : "The kind of supply (central, non-stock, etc.)",
"definition" : "Category of supply, e.g. central, non-stock, etc. This is used to support work flows associated with the supply process.",
"alias" : ["kind"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SupplyRequestKind"
}],
"strength" : "example",
"description" : "Category of supply request.",
"valueSet" : "http://hl7.org/fhir/ValueSet/supplyrequest-kind"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.class"
},
{
"identity" : "v2",
"map" : "N/A"
},
{
"identity" : "rim",
"map" : ".code"
}]
},
{
"id" : "SupplyRequest.priority",
"path" : "SupplyRequest.priority",
"short" : "routine | urgent | asap | stat",
"definition" : "Indicates how quickly this SupplyRequest should be addressed with respect to other requests.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "code"
}],
"meaningWhenMissing" : "If missing, this task should be performed with normal priority",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "RequestPriority"
}],
"strength" : "required",
"description" : "Identifies the level of importance to be assigned to actioning the request.",
"valueSet" : "http://hl7.org/fhir/ValueSet/request-priority|4.0.1"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.priority"
},
{
"identity" : "w5",
"map" : "FiveWs.grade"
},
{
"identity" : "v2",
"map" : "TQ1.9"
},
{
"identity" : "rim",
"map" : ".priorityCode"
}]
},
{
"id" : "SupplyRequest.item[x]",
"path" : "SupplyRequest.item[x]",
"short" : "Medication, Substance, or Device requested to be supplied",
"definition" : "The item that is requested to be supplied. This is either a link to a resource representing the details of the item or a code that identifies the item from a known list.",
"comment" : "Note that there's a difference between a prescription - an instruction to take a medication, along with a (sometimes) implicit supply, and an explicit request to supply, with no explicit instructions.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
},
{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Medication",
"http://hl7.org/fhir/StructureDefinition/Substance",
"http://hl7.org/fhir/StructureDefinition/Device"]
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SupplyRequestItem"
}],
"strength" : "example",
"description" : "The item that was requested.",
"valueSet" : "http://hl7.org/fhir/ValueSet/supply-item"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.code"
},
{
"identity" : "rim",
"map" : ".code"
}]
},
{
"id" : "SupplyRequest.quantity",
"path" : "SupplyRequest.quantity",
"short" : "The requested amount of the item indicated",
"definition" : "The amount that is being ordered of the indicated item.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "Quantity"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : ".quantity"
}]
},
{
"id" : "SupplyRequest.parameter",
"path" : "SupplyRequest.parameter",
"short" : "Ordered item details",
"definition" : "Specific parameters for the ordered item. For example, the size of the indicated item.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.what[x]"
},
{
"identity" : "v2",
"map" : "Varies by domain"
}]
},
{
"id" : "SupplyRequest.parameter.code",
"path" : "SupplyRequest.parameter.code",
"short" : "Item detail",
"definition" : "A code or string that identifies the device detail being asserted.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ParameterCode"
}],
"strength" : "example",
"description" : "A code that identifies the device detail."
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.what[x]"
},
{
"identity" : "v2",
"map" : "Varies by domain"
},
{
"identity" : "rim",
"map" : ".code"
}]
},
{
"id" : "SupplyRequest.parameter.value[x]",
"path" : "SupplyRequest.parameter.value[x]",
"short" : "Value of detail",
"definition" : "The value of the device detail.",
"comment" : "Range means device should have a value that falls somewhere within the specified range.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
},
{
"code" : "Quantity"
},
{
"code" : "Range"
},
{
"code" : "boolean"
}],
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.what[x]"
},
{
"identity" : "v2",
"map" : "Varies by domain"
},
{
"identity" : "rim",
"map" : ".code"
}]
},
{
"id" : "SupplyRequest.occurrence[x]",
"path" : "SupplyRequest.occurrence[x]",
"short" : "When the request should be fulfilled",
"definition" : "When the request should be fulfilled.",
"alias" : ["when",
"timing"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "dateTime"
},
{
"code" : "Period"
},
{
"code" : "Timing"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.occurrence[x]"
},
{
"identity" : "w5",
"map" : "FiveWs.planned"
},
{
"identity" : "v2",
"map" : "Accompanying TQ1/TQ2 segments"
},
{
"identity" : "rim",
"map" : ".effectiveTime"
}]
},
{
"id" : "SupplyRequest.authoredOn",
"path" : "SupplyRequest.authoredOn",
"short" : "When the request was made",
"definition" : "When the request was made.",
"alias" : ["date",
"createdOn",
"signedOn"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "dateTime"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.authoredOn"
},
{
"identity" : "w5",
"map" : "FiveWs.recorded"
},
{
"identity" : "v2",
"map" : "ORC.9"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=AUT].time"
}]
},
{
"id" : "SupplyRequest.requester",
"path" : "SupplyRequest.requester",
"short" : "Individual making the request",
"definition" : "The device, practitioner, etc. who initiated the request.",
"alias" : ["author",
"source"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Organization",
"http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson",
"http://hl7.org/fhir/StructureDefinition/Device"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.requester"
},
{
"identity" : "w5",
"map" : "FiveWs.author"
},
{
"identity" : "v2",
"map" : "ORC.12"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=AUT].role"
}]
},
{
"id" : "SupplyRequest.supplier",
"path" : "SupplyRequest.supplier",
"short" : "Who is intended to fulfill the request",
"definition" : "Who is intended to fulfill the request.",
"alias" : ["performer"],
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization",
"http://hl7.org/fhir/StructureDefinition/HealthcareService"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.performer"
},
{
"identity" : "w5",
"map" : "FiveWs.actor"
},
{
"identity" : "v2",
"map" : "PRT"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]"
}]
},
{
"id" : "SupplyRequest.reasonCode",
"path" : "SupplyRequest.reasonCode",
"short" : "The reason why the supply item was requested",
"definition" : "The reason why the supply item was requested.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SupplyRequestReason"
}],
"strength" : "example",
"description" : "The reason why the supply item was requested.",
"valueSet" : "http://hl7.org/fhir/ValueSet/supplyrequest-reason"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.reasonCode"
},
{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "v2",
"map" : "ORC.16"
},
{
"identity" : "rim",
"map" : ".reasonCode"
}]
},
{
"id" : "SupplyRequest.reasonReference",
"path" : "SupplyRequest.reasonReference",
"short" : "The reason why the supply item was requested",
"definition" : "The reason why the supply item was requested.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Condition",
"http://hl7.org/fhir/StructureDefinition/Observation",
"http://hl7.org/fhir/StructureDefinition/DiagnosticReport",
"http://hl7.org/fhir/StructureDefinition/DocumentReference"]
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Request.reasonReference"
},
{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "v2",
"map" : "ORC.16"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=RSON].target"
}]
},
{
"id" : "SupplyRequest.deliverFrom",
"path" : "SupplyRequest.deliverFrom",
"short" : "The origin of the supply",
"definition" : "Where the supply is expected to come from.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization",
"http://hl7.org/fhir/StructureDefinition/Location"]
}],
"mapping" : [{
"identity" : "v2",
"map" : "PRT"
},
{
"identity" : "rim",
"map" : ".participation"
}]
},
{
"id" : "SupplyRequest.deliverTo",
"path" : "SupplyRequest.deliverTo",
"short" : "The destination of the supply",
"definition" : "Where the supply is destined to go.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization",
"http://hl7.org/fhir/StructureDefinition/Location",
"http://hl7.org/fhir/StructureDefinition/Patient"]
}],
"mapping" : [{
"identity" : "v2",
"map" : "PRT"
},
{
"identity" : "rim",
"map" : ".participation"
}]
}]
}
}
},
{
"fullUrl" : "http://hl7.org/fhir/StructureDefinition/Task",
"resource" : {
"resourceType" : "StructureDefinition",
"id" : "Task",
"meta" : {
"lastUpdated" : "2019-11-01T09:29:23.356+11:00"
},
"text" : {
"status" : "generated",
"div" : "Name Flags Card. Type Description & Constraints Task ITU DomainResource A task to be performed
+ 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 identifier 0..* Identifier Task Instance Identifier
instantiatesCanonical Σ 0..1 canonical(ActivityDefinition) Formal definition of task instantiatesUri Σ 0..1 uri Formal definition of task basedOn Σ 0..* Reference(Any) Request fulfilled by this task
groupIdentifier Σ 0..1 Identifier Requisition or grouper id partOf Σ 0..* Reference(Task) Composite task
status ?!Σ 1..1 code draft | requested | received | accepted | +
TaskStatus (Required) statusReason Σ 0..1 CodeableConcept Reason for current status businessStatus Σ 0..1 CodeableConcept E.g. "Specimen collected", "IV prepped" intent Σ 1..1 code unknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
TaskIntent (Required) priority 0..1 code routine | urgent | asap | stat
Request priority (Required) code Σ 0..1 CodeableConcept Task Type
Task Codes (Example) description Σ 0..1 string Human-readable explanation of task focus Σ 0..1 Reference(Any) What task is acting on for Σ 0..1 Reference(Any) Beneficiary of the Task encounter Σ 0..1 Reference(Encounter) Healthcare event during which this task originated executionPeriod Σ 0..1 Period Start and end time of execution authoredOn I 0..1 dateTime Task Creation Date lastModified ΣI 0..1 dateTime Task Last Modified Date requester Σ 0..1 Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) Who is asking for task to be done performerType 0..* CodeableConcept Requested performer
Procedure Performer Role Codes (Preferred)
owner Σ 0..1 Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) Responsible individual location Σ 0..1 Reference(Location) Where task occurs reasonCode 0..1 CodeableConcept Why task is needed reasonReference 0..1 Reference(Any) Why task is needed insurance 0..* Reference(Coverage | ClaimResponse) Associated insurance coverage
note 0..* Annotation Comments made about the task
relevantHistory 0..* Reference(Provenance) Key events in history of the Task
restriction 0..1 BackboneElement Constraints on fulfillment tasks repetitions 0..1 positiveInt How many times to repeat period 0..1 Period When fulfillment sought recipient 0..* Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Group | Organization) For whom is fulfillment sought?
input 0..* BackboneElement Information used to perform task
type 1..1 CodeableConcept Label for the input value[x] 1..1 * Content to use in performing the task output 0..* BackboneElement Information produced as part of task
type 1..1 CodeableConcept Label for output value[x] 1..1 * Result of output
Documentation for this format
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Base.Workflow"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 2
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "not-classified"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "oo"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/Task",
"version" : "4.0.1",
"name" : "Task",
"status" : "draft",
"date" : "2019-11-01T09:29:23+11:00",
"publisher" : "Health Level Seven International (Orders and Observations)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/orders/index.cfm"
}]
}],
"description" : "A task to be performed.",
"fhirVersion" : "4.0.1",
"mapping" : [{
"identity" : "workflow",
"uri" : "http://hl7.org/fhir/workflow",
"name" : "Workflow Pattern"
},
{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/fivews",
"name" : "FiveWs Pattern Mapping"
},
{
"identity" : "v2",
"uri" : "http://hl7.org/v2",
"name" : "HL7 v2 Mapping"
}],
"kind" : "resource",
"abstract" : false,
"type" : "Task",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "Task",
"path" : "Task",
"short" : "A task to be performed",
"definition" : "A task to be performed.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Task",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "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",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.`div`.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "inv-1",
"severity" : "error",
"human" : "Last modified date must be greater than or equal to authored-on date.",
"expression" : "lastModified.exists().not() or authoredOn.exists().not() or lastModified >= authoredOn",
"xpath" : "not(exists(f:lastModified/@value)) or not(exists(f:authoredOn/@value)) or f:lastModified/@value >= f:authoredOn/@value"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "workflow",
"map" : "Request, Event"
},
{
"identity" : "rim",
"map" : "ControlAct[moodCode=INT]"
}]
},
{
"id" : "Task.id",
"path" : "Task.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Task.meta",
"path" : "Task.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Task.implicitRules",
"path" : "Task.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "Task.language",
"path" : "Task.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "Task.text",
"path" : "Task.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "Task.contained",
"path" : "Task.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Task.extension",
"path" : "Task.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Task.modifierExtension",
"path" : "Task.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Task.identifier",
"path" : "Task.identifier",
"short" : "Task Instance Identifier",
"definition" : "The business identifier for this task.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Task.identifier",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Identifier"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.identifier, Event.identifier"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "rim",
"map" : ".id"
}]
},
{
"id" : "Task.instantiatesCanonical",
"path" : "Task.instantiatesCanonical",
"short" : "Formal definition of task",
"definition" : "The URL pointing to a *FHIR*-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Task.",
"requirements" : "Enables a formal definition of how he task is to be performed, enabling automation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Task.instantiatesCanonical",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ActivityDefinition"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.instantiatesCanonical, Event.instantiatesCanonical"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=DEFN].target"
}]
},
{
"id" : "Task.instantiatesUri",
"path" : "Task.instantiatesUri",
"short" : "Formal definition of task",
"definition" : "The URL pointing to an *externally* maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Task.",
"requirements" : "Enables a formal definition of how he task is to be performed (e.g. using BPMN, BPEL, XPDL or other formal notation to be associated with a task), enabling automation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Task.instantiatesUri",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.instantiatesUrl"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=DEFN].target"
}]
},
{
"id" : "Task.basedOn",
"path" : "Task.basedOn",
"short" : "Request fulfilled by this task",
"definition" : "BasedOn refers to a higher-level authorization that triggered the creation of the task. It references a \"request\" resource such as a ServiceRequest, MedicationRequest, ServiceRequest, CarePlan, etc. which is distinct from the \"request\" resource the task is seeking to fulfill. This latter resource is referenced by FocusOn. For example, based on a ServiceRequest (= BasedOn), a task is created to fulfill a procedureRequest ( = FocusOn ) to collect a specimen from a patient.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Task.basedOn",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.basedOn, Event.basedOn"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=FLFS].target[moodCode=INT]"
}]
},
{
"id" : "Task.groupIdentifier",
"path" : "Task.groupIdentifier",
"short" : "Requisition or grouper id",
"definition" : "An identifier that links together multiple tasks and other requests that were created in the same context.",
"requirements" : "Billing and/or reporting can be linked to whether multiple requests were created as a single unit.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Task.groupIdentifier",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Identifier"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.groupIdentifier"
},
{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=COMP].source[moodCode=INT].id"
}]
},
{
"id" : "Task.partOf",
"path" : "Task.partOf",
"short" : "Composite task",
"definition" : "Task that this particular task is part of.",
"comment" : "This should usually be 0..1.",
"requirements" : "Allows tasks to be broken down into sub-steps (and this division can occur independent of the original task).",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Task.partOf",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Task"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.partOf"
},
{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=COMP].source[moodCode=INT]"
}]
},
{
"id" : "Task.status",
"path" : "Task.status",
"short" : "draft | requested | received | accepted | +",
"definition" : "The current status of the task.",
"requirements" : "These states enable coordination of task status with off-the-shelf workflow solutions that support automation of tasks.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Task.status",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "TaskStatus"
}],
"strength" : "required",
"description" : "The current status of the task.",
"valueSet" : "http://hl7.org/fhir/ValueSet/task-status|4.0.1"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.status, Event.status"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
},
{
"identity" : "rim",
"map" : ".statusCode"
}]
},
{
"id" : "Task.statusReason",
"path" : "Task.statusReason",
"short" : "Reason for current status",
"definition" : "An explanation as to why this task is held, failed, was refused, etc.",
"comment" : "This applies to the current status. Look at the history of the task to see reasons for past statuses.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Task.statusReason",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "TaskStatusReason"
}],
"strength" : "example",
"description" : "Codes to identify the reason for current status. These will typically be specific to a particular workflow."
},
"mapping" : [{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=SUBJ].source[classCode=CACT, moodCode=EVN, code=\"status change\"].reasonCode"
}]
},
{
"id" : "Task.businessStatus",
"path" : "Task.businessStatus",
"short" : "E.g. \"Specimen collected\", \"IV prepped\"",
"definition" : "Contains business-specific nuances of the business state.",
"requirements" : "There's often a need to track substates of a task - this is often variable by specific workflow implementation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Task.businessStatus",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "TaskBusinessStatus"
}],
"strength" : "example",
"description" : "The domain-specific business-contextual sub-state of the task. For example: \"Blood drawn\", \"IV inserted\", \"Awaiting physician signature\", etc."
},
"mapping" : [{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"business status\"]"
}]
},
{
"id" : "Task.intent",
"path" : "Task.intent",
"short" : "unknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option",
"definition" : "Indicates the \"level\" of actionability associated with the Task, i.e. i+R[9]Cs this a proposed task, a planned task, an actionable task, etc.",
"comment" : "This element is immutable. Proposed tasks, planned tasks, etc. must be distinct instances.\n\nIn most cases, Tasks will have an intent of \"order\".",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Task.intent",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "TaskIntent"
}],
"strength" : "required",
"description" : "Distinguishes whether the task is a proposal, plan or full order.",
"valueSet" : "http://hl7.org/fhir/ValueSet/task-intent|4.0.1"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.intent"
},
{
"identity" : "w5",
"map" : "FiveWs.class"
},
{
"identity" : "rim",
"map" : ".moodCode"
}]
},
{
"id" : "Task.priority",
"path" : "Task.priority",
"short" : "routine | urgent | asap | stat",
"definition" : "Indicates how quickly the Task should be addressed with respect to other requests.",
"requirements" : "Used to identify the service level expected while performing a task.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Task.priority",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"meaningWhenMissing" : "If missing, this task should be performed with normal priority",
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "TaskPriority"
}],
"strength" : "required",
"description" : "The task's priority.",
"valueSet" : "http://hl7.org/fhir/ValueSet/request-priority|4.0.1"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.priority"
},
{
"identity" : "w5",
"map" : "FiveWs.grade"
},
{
"identity" : "rim",
"map" : ".priorityCode"
}]
},
{
"id" : "Task.code",
"path" : "Task.code",
"short" : "Task Type",
"definition" : "A name or code (or both) briefly describing what the task involves.",
"comment" : "The title (eg \"My Tasks\", \"Outstanding Tasks for Patient X\") should go into the code.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Task.code",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "TaskCode"
}],
"strength" : "example",
"description" : "Codes to identify what the task involves. These will typically be specific to a particular workflow.",
"valueSet" : "http://hl7.org/fhir/ValueSet/task-code"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.code, Event.code"
},
{
"identity" : "w5",
"map" : "FiveWs.what[x]"
},
{
"identity" : "rim",
"map" : ".code"
}]
},
{
"id" : "Task.description",
"path" : "Task.description",
"short" : "Human-readable explanation of task",
"definition" : "A free-text description of what is to be performed.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Task.description",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : ".text"
}]
},
{
"id" : "Task.focus",
"path" : "Task.focus",
"short" : "What task is acting on",
"definition" : "The request being actioned or the resource being manipulated by this task.",
"comment" : "If multiple resources need to be manipulated, use sub-tasks. (This ensures that status can be tracked independently for each referenced resource.).",
"requirements" : "Used to identify the thing to be done.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Task.focus",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.what[x]"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=SUBJ].target"
}]
},
{
"id" : "Task.for",
"path" : "Task.for",
"short" : "Beneficiary of the Task",
"definition" : "The entity who benefits from the performance of the service specified in the task (e.g., the patient).",
"requirements" : "Used to track tasks outstanding for a beneficiary. Do not use to track the task owner or creator (see owner and creator respectively). This can also affect access control.",
"alias" : ["Patient"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Task.for",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.subject, Event.subject"
},
{
"identity" : "w5",
"map" : "FiveWs.subject[x]"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=RCT].role"
},
{
"identity" : "w5",
"map" : "FiveWs.subject"
}]
},
{
"id" : "Task.encounter",
"path" : "Task.encounter",
"short" : "Healthcare event during which this task originated",
"definition" : "The healthcare event (e.g. a patient and healthcare provider interaction) during which this task was created.",
"requirements" : "For some tasks it may be important to know the link between the encounter the task originated within.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Task.encounter",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Encounter"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.context, Event.context"
},
{
"identity" : "w5",
"map" : "FiveWs.context"
},
{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=COMP].source[classCode=PCPR, moodCode=EVN]"
}]
},
{
"id" : "Task.executionPeriod",
"path" : "Task.executionPeriod",
"short" : "Start and end time of execution",
"definition" : "Identifies the time action was first taken against the task (start) and/or the time final action was taken against the task prior to marking it as completed (end).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Task.executionPeriod",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Period"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.occurrence[x]"
},
{
"identity" : "w5",
"map" : "FiveWs.done[x]"
},
{
"identity" : "rim",
"map" : ".effectiveTime"
}]
},
{
"id" : "Task.authoredOn",
"path" : "Task.authoredOn",
"short" : "Task Creation Date",
"definition" : "The date and time this task was created.",
"requirements" : "Most often used along with lastUpdated to track duration of task to supporting monitoring and management.",
"alias" : ["Created Date"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Task.authoredOn",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
}],
"condition" : ["inv-1"],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.authoredOn"
},
{
"identity" : "w5",
"map" : "FiveWs.recorded"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=AUT].time"
}]
},
{
"id" : "Task.lastModified",
"path" : "Task.lastModified",
"short" : "Task Last Modified Date",
"definition" : "The date and time of last modification to this task.",
"requirements" : "Used along with history to track task activity and time in a particular task state. This enables monitoring and management.",
"alias" : ["Update Date"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Task.lastModified",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
}],
"condition" : ["inv-1"],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=SUBJ, ].source[classCode=CACT, moodCode=EVN].effectiveTime"
}]
},
{
"id" : "Task.requester",
"path" : "Task.requester",
"short" : "Who is asking for task to be done",
"definition" : "The creator of the task.",
"requirements" : "Identifies who created this task. May be used by access control mechanisms (e.g., to ensure that only the creator can cancel a task).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Task.requester",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Device",
"http://hl7.org/fhir/StructureDefinition/Organization",
"http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.requester"
},
{
"identity" : "w5",
"map" : "FiveWs.author"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=AUT].role"
}]
},
{
"id" : "Task.performerType",
"path" : "Task.performerType",
"short" : "Requested performer",
"definition" : "The kind of participant that should perform the task.",
"requirements" : "Use to distinguish tasks on different activity queues.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Task.performerType",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "TaskPerformerType"
}],
"strength" : "preferred",
"description" : "The type(s) of task performers allowed.",
"valueSet" : "http://hl7.org/fhir/ValueSet/performer-role"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.performer.role, Request.performerType"
},
{
"identity" : "w5",
"map" : "FiveWs.actor"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=PRF].role.code"
}]
},
{
"id" : "Task.owner",
"path" : "Task.owner",
"short" : "Responsible individual",
"definition" : "Individual organization or Device currently responsible for task execution.",
"comment" : "Tasks may be created with an owner not yet identified.",
"requirements" : "Identifies who is expected to perform this task.",
"alias" : ["Performer",
"Executer"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Task.owner",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Organization",
"http://hl7.org/fhir/StructureDefinition/CareTeam",
"http://hl7.org/fhir/StructureDefinition/HealthcareService",
"http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Device",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.performer.actor, Request.performer"
},
{
"identity" : "w5",
"map" : "FiveWs.actor"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=PRF].role"
}]
},
{
"id" : "Task.location",
"path" : "Task.location",
"short" : "Where task occurs",
"definition" : "Principal physical location where the this task is performed.",
"requirements" : "Ties the event to where the records are likely kept and provides context around the event occurrence (e.g. if it occurred inside or outside a dedicated healthcare setting).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Task.location",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Location"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.reasonCode, Event.reasonCode"
},
{
"identity" : "w5",
"map" : "FiveWs.where[x]"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=LOC].role"
}]
},
{
"id" : "Task.reasonCode",
"path" : "Task.reasonCode",
"short" : "Why task is needed",
"definition" : "A description or code indicating why this task needs to be performed.",
"comment" : "This should only be included if there is no focus or if it differs from the reason indicated on the focus.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Task.reasonCode",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "TaskReason"
}],
"strength" : "example",
"description" : "Indicates why the task is needed. E.g. Suspended because patient admitted to hospital."
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.location"
},
{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "v2",
"map" : "EVN.7"
},
{
"identity" : "rim",
"map" : ".reasonCode"
}]
},
{
"id" : "Task.reasonReference",
"path" : "Task.reasonReference",
"short" : "Why task is needed",
"definition" : "A resource reference indicating why this task needs to be performed.",
"comment" : "Tasks might be justified based on an Observation, a Condition, a past or planned procedure, etc. This should only be included if there is no focus or if it differs from the reason indicated on the focus. Use the CodeableConcept text element in `Task.reasonCode` if the data is free (uncoded) text.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Task.reasonReference",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.reasonReference, Event.reasonReference"
},
{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=RSON].target"
}]
},
{
"id" : "Task.insurance",
"path" : "Task.insurance",
"short" : "Associated insurance coverage",
"definition" : "Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be relevant to the Task.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Task.insurance",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Coverage",
"http://hl7.org/fhir/StructureDefinition/ClaimResponse"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.insurance"
},
{
"identity" : "v2",
"map" : "IN1/IN2"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=COVBY].target"
}]
},
{
"id" : "Task.note",
"path" : "Task.note",
"short" : "Comments made about the task",
"definition" : "Free-text information captured about the task as it progresses.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Task.note",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Annotation"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.note, Event.note"
},
{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=SUBJ, ].source[classCode=OBS, moodCode=EVN, code=\"annotation\"].value(string)"
}]
},
{
"id" : "Task.relevantHistory",
"path" : "Task.relevantHistory",
"short" : "Key events in history of the Task",
"definition" : "Links to Provenance records for past versions of this Task that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the task.",
"comment" : "This element does not point to the Provenance associated with the *current* version of the resource - as it would be created after this version existed. The Provenance for the current version can be retrieved with a _revinclude.",
"alias" : ["Status History"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Task.relevantHistory",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Provenance"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.relevantHistory"
},
{
"identity" : "rim",
"map" : ".inboundRelationship(typeCode=SUBJ].source[classCode=CACT, moodCode=EVN]"
}]
},
{
"id" : "Task.restriction",
"path" : "Task.restriction",
"short" : "Constraints on fulfillment tasks",
"definition" : "If the Task.focus is a request resource and the task is seeking fulfillment (i.e. is asking for the request to be actioned), this element identifies any limitations on what parts of the referenced request should be actioned.",
"requirements" : "Sometimes when fulfillment is sought, you don't want full fulfillment.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Task.restriction",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Instead of pointing to request, would point to component of request, having these characteristics"
}]
},
{
"id" : "Task.restriction.id",
"path" : "Task.restriction.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Task.restriction.extension",
"path" : "Task.restriction.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Task.restriction.modifierExtension",
"path" : "Task.restriction.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Task.restriction.repetitions",
"path" : "Task.restriction.repetitions",
"short" : "How many times to repeat",
"definition" : "Indicates the number of times the requested action should occur.",
"requirements" : "E.g. order that requests monthly lab tests, fulfillment is sought for 1.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Task.restriction.repetitions",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "positiveInt"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".repeatNumber"
}]
},
{
"id" : "Task.restriction.period",
"path" : "Task.restriction.period",
"short" : "When fulfillment sought",
"definition" : "Over what time-period is fulfillment sought.",
"comment" : "Note that period.high is the due date representing the time by which the task should be completed.",
"requirements" : "E.g. order that authorizes 1 year's services. Fulfillment is sought for next 3 months.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Task.restriction.period",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Period"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".effectiveTime(IVL)"
}]
},
{
"id" : "Task.restriction.recipient",
"path" : "Task.restriction.recipient",
"short" : "For whom is fulfillment sought?",
"definition" : "For requests that are targeted to more than on potential recipient/target, for whom is fulfillment sought?",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Task.restriction.recipient",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson",
"http://hl7.org/fhir/StructureDefinition/Group",
"http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : ".participation[typeCode=SBJ].role"
}]
},
{
"id" : "Task.input",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "Parameter"
}],
"path" : "Task.input",
"short" : "Information used to perform task",
"definition" : "Additional information that may be needed in the execution of the task.",
"requirements" : "Resources and data used to perform the task. This data is used in the business logic of task execution, and is stored separately because it varies between workflows.",
"alias" : ["Supporting Information"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Task.input",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "???"
}]
},
{
"id" : "Task.input.id",
"path" : "Task.input.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Task.input.extension",
"path" : "Task.input.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Task.input.modifierExtension",
"path" : "Task.input.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Task.input.type",
"path" : "Task.input.type",
"short" : "Label for the input",
"definition" : "A code or description indicating how the input is intended to be used as part of the task execution.",
"comment" : "If referencing a BPMN workflow or Protocol, the \"system\" is the URL for the workflow definition and the code is the \"name\" of the required input.",
"requirements" : "Inputs are named to enable task automation to bind data and pass it from one task to the next.",
"alias" : ["Name"],
"min" : 1,
"max" : "1",
"base" : {
"path" : "Task.input.type",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "TaskInputParameterType"
}],
"strength" : "example",
"description" : "Codes to identify types of input parameters. These will typically be specific to a particular workflow. E.g. \"Comparison source\", \"Applicable consent\", \"Concomitent Medications\", etc."
},
"mapping" : [{
"identity" : "rim",
"map" : "???"
}]
},
{
"id" : "Task.input.value[x]",
"path" : "Task.input.value[x]",
"short" : "Content to use in performing the task",
"definition" : "The value of the input parameter as a basic type.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Task.input.value[x]",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "base64Binary"
},
{
"code" : "boolean"
},
{
"code" : "canonical"
},
{
"code" : "code"
},
{
"code" : "date"
},
{
"code" : "dateTime"
},
{
"code" : "decimal"
},
{
"code" : "id"
},
{
"code" : "instant"
},
{
"code" : "integer"
},
{
"code" : "markdown"
},
{
"code" : "oid"
},
{
"code" : "positiveInt"
},
{
"code" : "string"
},
{
"code" : "time"
},
{
"code" : "unsignedInt"
},
{
"code" : "uri"
},
{
"code" : "url"
},
{
"code" : "uuid"
},
{
"code" : "Address"
},
{
"code" : "Age"
},
{
"code" : "Annotation"
},
{
"code" : "Attachment"
},
{
"code" : "CodeableConcept"
},
{
"code" : "Coding"
},
{
"code" : "ContactPoint"
},
{
"code" : "Count"
},
{
"code" : "Distance"
},
{
"code" : "Duration"
},
{
"code" : "HumanName"
},
{
"code" : "Identifier"
},
{
"code" : "Money"
},
{
"code" : "Period"
},
{
"code" : "Quantity"
},
{
"code" : "Range"
},
{
"code" : "Ratio"
},
{
"code" : "Reference"
},
{
"code" : "SampledData"
},
{
"code" : "Signature"
},
{
"code" : "Timing"
},
{
"code" : "ContactDetail"
},
{
"code" : "Contributor"
},
{
"code" : "DataRequirement"
},
{
"code" : "Expression"
},
{
"code" : "ParameterDefinition"
},
{
"code" : "RelatedArtifact"
},
{
"code" : "TriggerDefinition"
},
{
"code" : "UsageContext"
},
{
"code" : "Dosage"
},
{
"code" : "Meta"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "???"
}]
},
{
"id" : "Task.output",
"path" : "Task.output",
"short" : "Information produced as part of task",
"definition" : "Outputs produced by the Task.",
"requirements" : "Resources and data produced during the execution the task. This data is generated by the business logic of task execution, and is stored separately because it varies between workflows.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Task.output",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "???"
}]
},
{
"id" : "Task.output.id",
"path" : "Task.output.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Task.output.extension",
"path" : "Task.output.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Task.output.modifierExtension",
"path" : "Task.output.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Task.output.type",
"path" : "Task.output.type",
"short" : "Label for output",
"definition" : "The name of the Output parameter.",
"requirements" : "Outputs are named to enable task automation to bind data and pass it from one task to the next.",
"alias" : ["Name"],
"min" : 1,
"max" : "1",
"base" : {
"path" : "Task.output.type",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "TaskOutputParameterType"
}],
"strength" : "example",
"description" : "Codes to identify types of input parameters. These will typically be specific to a particular workflow. E.g. \"Identified issues\", \"Preliminary results\", \"Filler order\", \"Final results\", etc."
},
"mapping" : [{
"identity" : "rim",
"map" : "???"
}]
},
{
"id" : "Task.output.value[x]",
"path" : "Task.output.value[x]",
"short" : "Result of output",
"definition" : "The value of the Output parameter as a basic type.",
"requirements" : "Task outputs can take any form.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Task.output.value[x]",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "base64Binary"
},
{
"code" : "boolean"
},
{
"code" : "canonical"
},
{
"code" : "code"
},
{
"code" : "date"
},
{
"code" : "dateTime"
},
{
"code" : "decimal"
},
{
"code" : "id"
},
{
"code" : "instant"
},
{
"code" : "integer"
},
{
"code" : "markdown"
},
{
"code" : "oid"
},
{
"code" : "positiveInt"
},
{
"code" : "string"
},
{
"code" : "time"
},
{
"code" : "unsignedInt"
},
{
"code" : "uri"
},
{
"code" : "url"
},
{
"code" : "uuid"
},
{
"code" : "Address"
},
{
"code" : "Age"
},
{
"code" : "Annotation"
},
{
"code" : "Attachment"
},
{
"code" : "CodeableConcept"
},
{
"code" : "Coding"
},
{
"code" : "ContactPoint"
},
{
"code" : "Count"
},
{
"code" : "Distance"
},
{
"code" : "Duration"
},
{
"code" : "HumanName"
},
{
"code" : "Identifier"
},
{
"code" : "Money"
},
{
"code" : "Period"
},
{
"code" : "Quantity"
},
{
"code" : "Range"
},
{
"code" : "Ratio"
},
{
"code" : "Reference"
},
{
"code" : "SampledData"
},
{
"code" : "Signature"
},
{
"code" : "Timing"
},
{
"code" : "ContactDetail"
},
{
"code" : "Contributor"
},
{
"code" : "DataRequirement"
},
{
"code" : "Expression"
},
{
"code" : "ParameterDefinition"
},
{
"code" : "RelatedArtifact"
},
{
"code" : "TriggerDefinition"
},
{
"code" : "UsageContext"
},
{
"code" : "Dosage"
},
{
"code" : "Meta"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "???"
}]
}]
},
"differential" : {
"element" : [{
"id" : "Task",
"path" : "Task",
"short" : "A task to be performed",
"definition" : "A task to be performed.",
"min" : 0,
"max" : "*",
"constraint" : [{
"key" : "inv-1",
"severity" : "error",
"human" : "Last modified date must be greater than or equal to authored-on date.",
"expression" : "lastModified.exists().not() or authoredOn.exists().not() or lastModified >= authoredOn",
"xpath" : "not(exists(f:lastModified/@value)) or not(exists(f:authoredOn/@value)) or f:lastModified/@value >= f:authoredOn/@value"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Request, Event"
},
{
"identity" : "rim",
"map" : "ControlAct[moodCode=INT]"
}]
},
{
"id" : "Task.identifier",
"path" : "Task.identifier",
"short" : "Task Instance Identifier",
"definition" : "The business identifier for this task.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Identifier"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Request.identifier, Event.identifier"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "rim",
"map" : ".id"
}]
},
{
"id" : "Task.instantiatesCanonical",
"path" : "Task.instantiatesCanonical",
"short" : "Formal definition of task",
"definition" : "The URL pointing to a *FHIR*-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Task.",
"requirements" : "Enables a formal definition of how he task is to be performed, enabling automation.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ActivityDefinition"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.instantiatesCanonical, Event.instantiatesCanonical"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=DEFN].target"
}]
},
{
"id" : "Task.instantiatesUri",
"path" : "Task.instantiatesUri",
"short" : "Formal definition of task",
"definition" : "The URL pointing to an *externally* maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Task.",
"requirements" : "Enables a formal definition of how he task is to be performed (e.g. using BPMN, BPEL, XPDL or other formal notation to be associated with a task), enabling automation.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "uri"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.instantiatesUrl"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=DEFN].target"
}]
},
{
"id" : "Task.basedOn",
"path" : "Task.basedOn",
"short" : "Request fulfilled by this task",
"definition" : "BasedOn refers to a higher-level authorization that triggered the creation of the task. It references a \"request\" resource such as a ServiceRequest, MedicationRequest, ServiceRequest, CarePlan, etc. which is distinct from the \"request\" resource the task is seeking to fulfill. This latter resource is referenced by FocusOn. For example, based on a ServiceRequest (= BasedOn), a task is created to fulfill a procedureRequest ( = FocusOn ) to collect a specimen from a patient.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.basedOn, Event.basedOn"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=FLFS].target[moodCode=INT]"
}]
},
{
"id" : "Task.groupIdentifier",
"path" : "Task.groupIdentifier",
"short" : "Requisition or grouper id",
"definition" : "An identifier that links together multiple tasks and other requests that were created in the same context.",
"requirements" : "Billing and/or reporting can be linked to whether multiple requests were created as a single unit.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Identifier"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.groupIdentifier"
},
{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=COMP].source[moodCode=INT].id"
}]
},
{
"id" : "Task.partOf",
"path" : "Task.partOf",
"short" : "Composite task",
"definition" : "Task that this particular task is part of.",
"comment" : "This should usually be 0..1.",
"requirements" : "Allows tasks to be broken down into sub-steps (and this division can occur independent of the original task).",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Task"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.partOf"
},
{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=COMP].source[moodCode=INT]"
}]
},
{
"id" : "Task.status",
"path" : "Task.status",
"short" : "draft | requested | received | accepted | +",
"definition" : "The current status of the task.",
"requirements" : "These states enable coordination of task status with off-the-shelf workflow solutions that support automation of tasks.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "TaskStatus"
}],
"strength" : "required",
"description" : "The current status of the task.",
"valueSet" : "http://hl7.org/fhir/ValueSet/task-status|4.0.1"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.status, Event.status"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
},
{
"identity" : "rim",
"map" : ".statusCode"
}]
},
{
"id" : "Task.statusReason",
"path" : "Task.statusReason",
"short" : "Reason for current status",
"definition" : "An explanation as to why this task is held, failed, was refused, etc.",
"comment" : "This applies to the current status. Look at the history of the task to see reasons for past statuses.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "TaskStatusReason"
}],
"strength" : "example",
"description" : "Codes to identify the reason for current status. These will typically be specific to a particular workflow."
},
"mapping" : [{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=SUBJ].source[classCode=CACT, moodCode=EVN, code=\"status change\"].reasonCode"
}]
},
{
"id" : "Task.businessStatus",
"path" : "Task.businessStatus",
"short" : "E.g. \"Specimen collected\", \"IV prepped\"",
"definition" : "Contains business-specific nuances of the business state.",
"requirements" : "There's often a need to track substates of a task - this is often variable by specific workflow implementation.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "TaskBusinessStatus"
}],
"strength" : "example",
"description" : "The domain-specific business-contextual sub-state of the task. For example: \"Blood drawn\", \"IV inserted\", \"Awaiting physician signature\", etc."
},
"mapping" : [{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"business status\"]"
}]
},
{
"id" : "Task.intent",
"path" : "Task.intent",
"short" : "unknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option",
"definition" : "Indicates the \"level\" of actionability associated with the Task, i.e. i+R[9]Cs this a proposed task, a planned task, an actionable task, etc.",
"comment" : "This element is immutable. Proposed tasks, planned tasks, etc. must be distinct instances.\n\nIn most cases, Tasks will have an intent of \"order\".",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "TaskIntent"
}],
"strength" : "required",
"description" : "Distinguishes whether the task is a proposal, plan or full order.",
"valueSet" : "http://hl7.org/fhir/ValueSet/task-intent|4.0.1"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.intent"
},
{
"identity" : "w5",
"map" : "FiveWs.class"
},
{
"identity" : "rim",
"map" : ".moodCode"
}]
},
{
"id" : "Task.priority",
"path" : "Task.priority",
"short" : "routine | urgent | asap | stat",
"definition" : "Indicates how quickly the Task should be addressed with respect to other requests.",
"requirements" : "Used to identify the service level expected while performing a task.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "code"
}],
"meaningWhenMissing" : "If missing, this task should be performed with normal priority",
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "TaskPriority"
}],
"strength" : "required",
"description" : "The task's priority.",
"valueSet" : "http://hl7.org/fhir/ValueSet/request-priority|4.0.1"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.priority"
},
{
"identity" : "w5",
"map" : "FiveWs.grade"
},
{
"identity" : "rim",
"map" : ".priorityCode"
}]
},
{
"id" : "Task.code",
"path" : "Task.code",
"short" : "Task Type",
"definition" : "A name or code (or both) briefly describing what the task involves.",
"comment" : "The title (eg \"My Tasks\", \"Outstanding Tasks for Patient X\") should go into the code.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "TaskCode"
}],
"strength" : "example",
"description" : "Codes to identify what the task involves. These will typically be specific to a particular workflow.",
"valueSet" : "http://hl7.org/fhir/ValueSet/task-code"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.code, Event.code"
},
{
"identity" : "w5",
"map" : "FiveWs.what[x]"
},
{
"identity" : "rim",
"map" : ".code"
}]
},
{
"id" : "Task.description",
"path" : "Task.description",
"short" : "Human-readable explanation of task",
"definition" : "A free-text description of what is to be performed.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : ".text"
}]
},
{
"id" : "Task.focus",
"path" : "Task.focus",
"short" : "What task is acting on",
"definition" : "The request being actioned or the resource being manipulated by this task.",
"comment" : "If multiple resources need to be manipulated, use sub-tasks. (This ensures that status can be tracked independently for each referenced resource.).",
"requirements" : "Used to identify the thing to be done.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.what[x]"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=SUBJ].target"
}]
},
{
"id" : "Task.for",
"path" : "Task.for",
"short" : "Beneficiary of the Task",
"definition" : "The entity who benefits from the performance of the service specified in the task (e.g., the patient).",
"requirements" : "Used to track tasks outstanding for a beneficiary. Do not use to track the task owner or creator (see owner and creator respectively). This can also affect access control.",
"alias" : ["Patient"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.subject, Event.subject"
},
{
"identity" : "w5",
"map" : "FiveWs.subject[x]"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=RCT].role"
},
{
"identity" : "w5",
"map" : "FiveWs.subject"
}]
},
{
"id" : "Task.encounter",
"path" : "Task.encounter",
"short" : "Healthcare event during which this task originated",
"definition" : "The healthcare event (e.g. a patient and healthcare provider interaction) during which this task was created.",
"requirements" : "For some tasks it may be important to know the link between the encounter the task originated within.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Encounter"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.context, Event.context"
},
{
"identity" : "w5",
"map" : "FiveWs.context"
},
{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=COMP].source[classCode=PCPR, moodCode=EVN]"
}]
},
{
"id" : "Task.executionPeriod",
"path" : "Task.executionPeriod",
"short" : "Start and end time of execution",
"definition" : "Identifies the time action was first taken against the task (start) and/or the time final action was taken against the task prior to marking it as completed (end).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Period"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.occurrence[x]"
},
{
"identity" : "w5",
"map" : "FiveWs.done[x]"
},
{
"identity" : "rim",
"map" : ".effectiveTime"
}]
},
{
"id" : "Task.authoredOn",
"path" : "Task.authoredOn",
"short" : "Task Creation Date",
"definition" : "The date and time this task was created.",
"requirements" : "Most often used along with lastUpdated to track duration of task to supporting monitoring and management.",
"alias" : ["Created Date"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "dateTime"
}],
"condition" : ["inv-1"],
"mapping" : [{
"identity" : "workflow",
"map" : "Request.authoredOn"
},
{
"identity" : "w5",
"map" : "FiveWs.recorded"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=AUT].time"
}]
},
{
"id" : "Task.lastModified",
"path" : "Task.lastModified",
"short" : "Task Last Modified Date",
"definition" : "The date and time of last modification to this task.",
"requirements" : "Used along with history to track task activity and time in a particular task state. This enables monitoring and management.",
"alias" : ["Update Date"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "dateTime"
}],
"condition" : ["inv-1"],
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=SUBJ, ].source[classCode=CACT, moodCode=EVN].effectiveTime"
}]
},
{
"id" : "Task.requester",
"path" : "Task.requester",
"short" : "Who is asking for task to be done",
"definition" : "The creator of the task.",
"requirements" : "Identifies who created this task. May be used by access control mechanisms (e.g., to ensure that only the creator can cancel a task).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Device",
"http://hl7.org/fhir/StructureDefinition/Organization",
"http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.requester"
},
{
"identity" : "w5",
"map" : "FiveWs.author"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=AUT].role"
}]
},
{
"id" : "Task.performerType",
"path" : "Task.performerType",
"short" : "Requested performer",
"definition" : "The kind of participant that should perform the task.",
"requirements" : "Use to distinguish tasks on different activity queues.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "TaskPerformerType"
}],
"strength" : "preferred",
"description" : "The type(s) of task performers allowed.",
"valueSet" : "http://hl7.org/fhir/ValueSet/performer-role"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.performer.role, Request.performerType"
},
{
"identity" : "w5",
"map" : "FiveWs.actor"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=PRF].role.code"
}]
},
{
"id" : "Task.owner",
"path" : "Task.owner",
"short" : "Responsible individual",
"definition" : "Individual organization or Device currently responsible for task execution.",
"comment" : "Tasks may be created with an owner not yet identified.",
"requirements" : "Identifies who is expected to perform this task.",
"alias" : ["Performer",
"Executer"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Organization",
"http://hl7.org/fhir/StructureDefinition/CareTeam",
"http://hl7.org/fhir/StructureDefinition/HealthcareService",
"http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Device",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.performer.actor, Request.performer"
},
{
"identity" : "w5",
"map" : "FiveWs.actor"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=PRF].role"
}]
},
{
"id" : "Task.location",
"path" : "Task.location",
"short" : "Where task occurs",
"definition" : "Principal physical location where the this task is performed.",
"requirements" : "Ties the event to where the records are likely kept and provides context around the event occurrence (e.g. if it occurred inside or outside a dedicated healthcare setting).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Location"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.reasonCode, Event.reasonCode"
},
{
"identity" : "w5",
"map" : "FiveWs.where[x]"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=LOC].role"
}]
},
{
"id" : "Task.reasonCode",
"path" : "Task.reasonCode",
"short" : "Why task is needed",
"definition" : "A description or code indicating why this task needs to be performed.",
"comment" : "This should only be included if there is no focus or if it differs from the reason indicated on the focus.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "TaskReason"
}],
"strength" : "example",
"description" : "Indicates why the task is needed. E.g. Suspended because patient admitted to hospital."
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.location"
},
{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "v2",
"map" : "EVN.7"
},
{
"identity" : "rim",
"map" : ".reasonCode"
}]
},
{
"id" : "Task.reasonReference",
"path" : "Task.reasonReference",
"short" : "Why task is needed",
"definition" : "A resource reference indicating why this task needs to be performed.",
"comment" : "Tasks might be justified based on an Observation, a Condition, a past or planned procedure, etc. This should only be included if there is no focus or if it differs from the reason indicated on the focus. Use the CodeableConcept text element in `Task.reasonCode` if the data is free (uncoded) text.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Request.reasonReference, Event.reasonReference"
},
{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=RSON].target"
}]
},
{
"id" : "Task.insurance",
"path" : "Task.insurance",
"short" : "Associated insurance coverage",
"definition" : "Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be relevant to the Task.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Coverage",
"http://hl7.org/fhir/StructureDefinition/ClaimResponse"]
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Request.insurance"
},
{
"identity" : "v2",
"map" : "IN1/IN2"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=COVBY].target"
}]
},
{
"id" : "Task.note",
"path" : "Task.note",
"short" : "Comments made about the task",
"definition" : "Free-text information captured about the task as it progresses.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Annotation"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Request.note, Event.note"
},
{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=SUBJ, ].source[classCode=OBS, moodCode=EVN, code=\"annotation\"].value(string)"
}]
},
{
"id" : "Task.relevantHistory",
"path" : "Task.relevantHistory",
"short" : "Key events in history of the Task",
"definition" : "Links to Provenance records for past versions of this Task that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the task.",
"comment" : "This element does not point to the Provenance associated with the *current* version of the resource - as it would be created after this version existed. The Provenance for the current version can be retrieved with a _revinclude.",
"alias" : ["Status History"],
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Provenance"]
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Request.relevantHistory"
},
{
"identity" : "rim",
"map" : ".inboundRelationship(typeCode=SUBJ].source[classCode=CACT, moodCode=EVN]"
}]
},
{
"id" : "Task.restriction",
"path" : "Task.restriction",
"short" : "Constraints on fulfillment tasks",
"definition" : "If the Task.focus is a request resource and the task is seeking fulfillment (i.e. is asking for the request to be actioned), this element identifies any limitations on what parts of the referenced request should be actioned.",
"requirements" : "Sometimes when fulfillment is sought, you don't want full fulfillment.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "BackboneElement"
}],
"mapping" : [{
"identity" : "rim",
"map" : "Instead of pointing to request, would point to component of request, having these characteristics"
}]
},
{
"id" : "Task.restriction.repetitions",
"path" : "Task.restriction.repetitions",
"short" : "How many times to repeat",
"definition" : "Indicates the number of times the requested action should occur.",
"requirements" : "E.g. order that requests monthly lab tests, fulfillment is sought for 1.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "positiveInt"
}],
"mapping" : [{
"identity" : "rim",
"map" : ".repeatNumber"
}]
},
{
"id" : "Task.restriction.period",
"path" : "Task.restriction.period",
"short" : "When fulfillment sought",
"definition" : "Over what time-period is fulfillment sought.",
"comment" : "Note that period.high is the due date representing the time by which the task should be completed.",
"requirements" : "E.g. order that authorizes 1 year's services. Fulfillment is sought for next 3 months.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Period"
}],
"mapping" : [{
"identity" : "rim",
"map" : ".effectiveTime(IVL)"
}]
},
{
"id" : "Task.restriction.recipient",
"path" : "Task.restriction.recipient",
"short" : "For whom is fulfillment sought?",
"definition" : "For requests that are targeted to more than on potential recipient/target, for whom is fulfillment sought?",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson",
"http://hl7.org/fhir/StructureDefinition/Group",
"http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"mapping" : [{
"identity" : "rim",
"map" : ".participation[typeCode=SBJ].role"
}]
},
{
"id" : "Task.input",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "Parameter"
}],
"path" : "Task.input",
"short" : "Information used to perform task",
"definition" : "Additional information that may be needed in the execution of the task.",
"requirements" : "Resources and data used to perform the task. This data is used in the business logic of task execution, and is stored separately because it varies between workflows.",
"alias" : ["Supporting Information"],
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"mapping" : [{
"identity" : "rim",
"map" : "???"
}]
},
{
"id" : "Task.input.type",
"path" : "Task.input.type",
"short" : "Label for the input",
"definition" : "A code or description indicating how the input is intended to be used as part of the task execution.",
"comment" : "If referencing a BPMN workflow or Protocol, the \"system\" is the URL for the workflow definition and the code is the \"name\" of the required input.",
"requirements" : "Inputs are named to enable task automation to bind data and pass it from one task to the next.",
"alias" : ["Name"],
"min" : 1,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "TaskInputParameterType"
}],
"strength" : "example",
"description" : "Codes to identify types of input parameters. These will typically be specific to a particular workflow. E.g. \"Comparison source\", \"Applicable consent\", \"Concomitent Medications\", etc."
},
"mapping" : [{
"identity" : "rim",
"map" : "???"
}]
},
{
"id" : "Task.input.value[x]",
"path" : "Task.input.value[x]",
"short" : "Content to use in performing the task",
"definition" : "The value of the input parameter as a basic type.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "base64Binary"
},
{
"code" : "boolean"
},
{
"code" : "canonical"
},
{
"code" : "code"
},
{
"code" : "date"
},
{
"code" : "dateTime"
},
{
"code" : "decimal"
},
{
"code" : "id"
},
{
"code" : "instant"
},
{
"code" : "integer"
},
{
"code" : "markdown"
},
{
"code" : "oid"
},
{
"code" : "positiveInt"
},
{
"code" : "string"
},
{
"code" : "time"
},
{
"code" : "unsignedInt"
},
{
"code" : "uri"
},
{
"code" : "url"
},
{
"code" : "uuid"
},
{
"code" : "Address"
},
{
"code" : "Age"
},
{
"code" : "Annotation"
},
{
"code" : "Attachment"
},
{
"code" : "CodeableConcept"
},
{
"code" : "Coding"
},
{
"code" : "ContactPoint"
},
{
"code" : "Count"
},
{
"code" : "Distance"
},
{
"code" : "Duration"
},
{
"code" : "HumanName"
},
{
"code" : "Identifier"
},
{
"code" : "Money"
},
{
"code" : "Period"
},
{
"code" : "Quantity"
},
{
"code" : "Range"
},
{
"code" : "Ratio"
},
{
"code" : "Reference"
},
{
"code" : "SampledData"
},
{
"code" : "Signature"
},
{
"code" : "Timing"
},
{
"code" : "ContactDetail"
},
{
"code" : "Contributor"
},
{
"code" : "DataRequirement"
},
{
"code" : "Expression"
},
{
"code" : "ParameterDefinition"
},
{
"code" : "RelatedArtifact"
},
{
"code" : "TriggerDefinition"
},
{
"code" : "UsageContext"
},
{
"code" : "Dosage"
},
{
"code" : "Meta"
}],
"mapping" : [{
"identity" : "rim",
"map" : "???"
}]
},
{
"id" : "Task.output",
"path" : "Task.output",
"short" : "Information produced as part of task",
"definition" : "Outputs produced by the Task.",
"requirements" : "Resources and data produced during the execution the task. This data is generated by the business logic of task execution, and is stored separately because it varies between workflows.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"mapping" : [{
"identity" : "rim",
"map" : "???"
}]
},
{
"id" : "Task.output.type",
"path" : "Task.output.type",
"short" : "Label for output",
"definition" : "The name of the Output parameter.",
"requirements" : "Outputs are named to enable task automation to bind data and pass it from one task to the next.",
"alias" : ["Name"],
"min" : 1,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "TaskOutputParameterType"
}],
"strength" : "example",
"description" : "Codes to identify types of input parameters. These will typically be specific to a particular workflow. E.g. \"Identified issues\", \"Preliminary results\", \"Filler order\", \"Final results\", etc."
},
"mapping" : [{
"identity" : "rim",
"map" : "???"
}]
},
{
"id" : "Task.output.value[x]",
"path" : "Task.output.value[x]",
"short" : "Result of output",
"definition" : "The value of the Output parameter as a basic type.",
"requirements" : "Task outputs can take any form.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "base64Binary"
},
{
"code" : "boolean"
},
{
"code" : "canonical"
},
{
"code" : "code"
},
{
"code" : "date"
},
{
"code" : "dateTime"
},
{
"code" : "decimal"
},
{
"code" : "id"
},
{
"code" : "instant"
},
{
"code" : "integer"
},
{
"code" : "markdown"
},
{
"code" : "oid"
},
{
"code" : "positiveInt"
},
{
"code" : "string"
},
{
"code" : "time"
},
{
"code" : "unsignedInt"
},
{
"code" : "uri"
},
{
"code" : "url"
},
{
"code" : "uuid"
},
{
"code" : "Address"
},
{
"code" : "Age"
},
{
"code" : "Annotation"
},
{
"code" : "Attachment"
},
{
"code" : "CodeableConcept"
},
{
"code" : "Coding"
},
{
"code" : "ContactPoint"
},
{
"code" : "Count"
},
{
"code" : "Distance"
},
{
"code" : "Duration"
},
{
"code" : "HumanName"
},
{
"code" : "Identifier"
},
{
"code" : "Money"
},
{
"code" : "Period"
},
{
"code" : "Quantity"
},
{
"code" : "Range"
},
{
"code" : "Ratio"
},
{
"code" : "Reference"
},
{
"code" : "SampledData"
},
{
"code" : "Signature"
},
{
"code" : "Timing"
},
{
"code" : "ContactDetail"
},
{
"code" : "Contributor"
},
{
"code" : "DataRequirement"
},
{
"code" : "Expression"
},
{
"code" : "ParameterDefinition"
},
{
"code" : "RelatedArtifact"
},
{
"code" : "TriggerDefinition"
},
{
"code" : "UsageContext"
},
{
"code" : "Dosage"
},
{
"code" : "Meta"
}],
"mapping" : [{
"identity" : "rim",
"map" : "???"
}]
}]
}
}
},
{
"fullUrl" : "http://hl7.org/fhir/StructureDefinition/TerminologyCapabilities",
"resource" : {
"resourceType" : "StructureDefinition",
"id" : "TerminologyCapabilities",
"meta" : {
"lastUpdated" : "2019-11-01T09:29:23.356+11:00"
},
"text" : {
"status" : "generated",
"div" : "Name Flags Card. Type Description & Constraints TerminologyCapabilities ITU 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 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
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension url Σ 0..1 uri Canonical identifier for this terminology capabilities, represented as a URI (globally unique) version Σ 0..1 string Business version of the terminology capabilities name ΣI 0..1 string Name for this terminology capabilities (computer friendly) title Σ 0..1 string Name for this terminology capabilities (human friendly) status ?!Σ 1..1 code draft | active | retired | unknown
PublicationStatus (Required) experimental Σ 0..1 boolean For testing purposes, not real usage date Σ 1..1 dateTime Date last changed publisher Σ 0..1 string Name of the publisher (organization or individual) contact Σ 0..* ContactDetail Contact details for the publisher
description 0..1 markdown Natural language description of the terminology capabilities useContext Σ 0..* UsageContext The context that the content is intended to support
jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for terminology capabilities (if applicable)
Jurisdiction (Extensible)
purpose 0..1 markdown Why this terminology capabilities is defined copyright Σ 0..1 markdown Use and/or publishing restrictions kind ΣI 1..1 code instance | capability | requirements
CapabilityStatementKind (Required) software ΣI 0..1 BackboneElement Software that is covered by this terminology capability statement name Σ 1..1 string A name the software is known by version Σ 0..1 string Version covered by this statement implementation ΣI 0..1 BackboneElement If this describes a specific instance description Σ 1..1 string Describes this specific instance url Σ 0..1 url Base URL for the implementation lockedDate Σ 0..1 boolean Whether lockedDate is supported codeSystem I 0..* BackboneElement A code system supported by the server
+ Rule: If there is more than one version, a version code must be defined
uri 0..1 canonical(CodeSystem) URI for the Code System version 0..* BackboneElement Version of Code System supported
code ΣI 0..1 string Version identifier for this version isDefault Σ 0..1 boolean If this is the default version for this code system compositional 0..1 boolean If compositional grammar is supported language 0..* code Language Displays supported
filter 0..* BackboneElement Filter Properties supported
code 1..1 code Code of the property supported op 1..* code Operations supported for the property
property 0..* code Properties supported for $lookup
subsumption 0..1 boolean Whether subsumption is supported expansion 0..1 BackboneElement Information about the [ValueSet/$expand](valueset-operation-expand.html) operation hierarchical 0..1 boolean Whether the server can return nested value sets paging 0..1 boolean Whether the server supports paging on expansion incomplete 0..1 boolean Allow request for incomplete expansions? parameter 0..* BackboneElement Supported expansion parameter
name 1..1 code Expansion Parameter name documentation 0..1 string Description of support for parameter textFilter 0..1 markdown Documentation about text searching works codeSearch 0..1 code explicit | all
CodeSearchSupport (Required) validateCode 0..1 BackboneElement Information about the [ValueSet/$validate-code](valueset-operation-validate-code.html) operation translations 1..1 boolean Whether translations are validated translation 0..1 BackboneElement Information about the [ConceptMap/$translate](conceptmap-operation-translate.html) operation needsMap 1..1 boolean Whether the client must identify the map closure 0..1 BackboneElement Information about the [ConceptMap/$closure](conceptmap-operation-closure.html) operation translation 0..1 boolean If cross-system closure is supported
Documentation for this format
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Foundation.Terminology"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 0
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "anonymous"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "vocab"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/TerminologyCapabilities",
"version" : "4.0.1",
"name" : "TerminologyCapabilities",
"status" : "draft",
"date" : "2019-11-01T09:29:23+11:00",
"publisher" : "Health Level Seven International (Vocabulary)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/Vocab/index.cfm"
}]
}],
"description" : "A TerminologyCapabilities resource documents a set of capabilities (behaviors) of a FHIR Terminology Server that may be used as a statement of actual server functionality or a statement of required or desired server implementation.",
"fhirVersion" : "4.0.1",
"mapping" : [{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
},
{
"identity" : "workflow",
"uri" : "http://hl7.org/fhir/workflow",
"name" : "Workflow Pattern"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/fivews",
"name" : "FiveWs Pattern Mapping"
},
{
"identity" : "objimpl",
"uri" : "http://hl7.org/fhir/object-implementation",
"name" : "Object Implementation Information"
}],
"kind" : "resource",
"abstract" : false,
"type" : "TerminologyCapabilities",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"_baseDefinition" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-codegen-super",
"valueString" : "MetadataResource"
}]
},
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "TerminologyCapabilities",
"path" : "TerminologyCapabilities",
"short" : "A statement of system capabilities",
"definition" : "A TerminologyCapabilities resource documents a set of capabilities (behaviors) of a FHIR Terminology Server that may be used as a statement of actual server functionality or a statement of required or desired server implementation.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "TerminologyCapabilities",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "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",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.`div`.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "tcp-0",
"severity" : "warning",
"human" : "Name should be usable as an identifier for the module by machine processing applications such as code generation",
"expression" : "name.matches('[A-Z]([A-Za-z0-9_]){0,254}')",
"xpath" : "not(exists(f:name/@value)) or matches(f:name/@value, '[A-Z]([A-Za-z0-9_]){0,254}')"
},
{
"key" : "tcp-2",
"severity" : "error",
"human" : "A Capability Statement SHALL have at least one of description, software, or implementation element.",
"expression" : "(description.count() + software.count() + implementation.count()) > 0",
"xpath" : "count(f:software | f:implementation | f:description) > 0"
},
{
"key" : "tcp-3",
"severity" : "error",
"human" : "If kind = instance, implementation must be present and software may be present",
"expression" : "(kind != 'instance') or implementation.exists()",
"xpath" : "not(f:kind/@value='instance') or exists(f:implementation)"
},
{
"key" : "tcp-4",
"severity" : "error",
"human" : "If kind = capability, implementation must be absent, software must be present",
"expression" : "(kind != 'capability') or (implementation.exists().not() and software.exists())",
"xpath" : " not(f:kind/@value='instance') or (not(exists(f:implementation)) and exists(f:software))"
},
{
"key" : "tcp-5",
"severity" : "error",
"human" : "If kind = requirements, implementation and software must be absent",
"expression" : "(kind!='requirements') or (implementation.exists().not() and software.exists().not())",
"xpath" : "not(f:kind/@value='instance') or (not(exists(f:implementation)) and not(exists(f:software)))"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "TerminologyCapabilities.id",
"path" : "TerminologyCapabilities.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "TerminologyCapabilities.meta",
"path" : "TerminologyCapabilities.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "TerminologyCapabilities.implicitRules",
"path" : "TerminologyCapabilities.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "TerminologyCapabilities.language",
"path" : "TerminologyCapabilities.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "TerminologyCapabilities.text",
"path" : "TerminologyCapabilities.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "TerminologyCapabilities.contained",
"path" : "TerminologyCapabilities.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "TerminologyCapabilities.extension",
"path" : "TerminologyCapabilities.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "TerminologyCapabilities.modifierExtension",
"path" : "TerminologyCapabilities.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "TerminologyCapabilities.url",
"path" : "TerminologyCapabilities.url",
"short" : "Canonical identifier for this terminology capabilities, represented as a URI (globally unique)",
"definition" : "An absolute URI that is used to identify this terminology capabilities when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this terminology capabilities is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the terminology capabilities is stored on different servers.",
"comment" : "Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.\n\nThe determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions). \n\nIn some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.",
"requirements" : "Allows the terminology capabilities to be referenced by a single globally unique identifier.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TerminologyCapabilities.url",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.url"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
}]
},
{
"id" : "TerminologyCapabilities.version",
"path" : "TerminologyCapabilities.version",
"short" : "Business version of the terminology capabilities",
"definition" : "The identifier that is used to identify this version of the terminology capabilities when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the terminology capabilities author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.",
"comment" : "There may be different terminology capabilities instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the terminology capabilities with the format [url]|[version].",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TerminologyCapabilities.version",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.version"
},
{
"identity" : "w5",
"map" : "FiveWs.version"
}]
},
{
"id" : "TerminologyCapabilities.name",
"path" : "TerminologyCapabilities.name",
"short" : "Name for this terminology capabilities (computer friendly)",
"definition" : "A natural language name identifying the terminology capabilities. This name should be usable as an identifier for the module by machine processing applications such as code generation.",
"comment" : "The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.",
"requirements" : "Support human navigation and code generation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TerminologyCapabilities.name",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"condition" : ["inv-0"],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "TerminologyCapabilities.title",
"path" : "TerminologyCapabilities.title",
"short" : "Name for this terminology capabilities (human friendly)",
"definition" : "A short, descriptive, user-friendly title for the terminology capabilities.",
"comment" : "This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TerminologyCapabilities.title",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.title"
}]
},
{
"id" : "TerminologyCapabilities.status",
"path" : "TerminologyCapabilities.status",
"short" : "draft | active | retired | unknown",
"definition" : "The status of this terminology capabilities. Enables tracking the life-cycle of the content.",
"comment" : "Allows filtering of terminology capabilitiess that are appropriate for use versus not.This is not intended for use with actual capability statements, but where capability statements are used to describe possible or desired systems.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "TerminologyCapabilities.status",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This is labeled as \"Is Modifier\" because applications should not use a retired {{title}} without due consideration",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "PublicationStatus"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "The lifecycle status of an artifact.",
"valueSet" : "http://hl7.org/fhir/ValueSet/publication-status|4.0.1"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.status"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
}]
},
{
"id" : "TerminologyCapabilities.experimental",
"path" : "TerminologyCapabilities.experimental",
"short" : "For testing purposes, not real usage",
"definition" : "A Boolean value to indicate that this terminology capabilities is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.",
"comment" : "Allows filtering of terminology capabilitiess that are appropriate for use versus not.",
"requirements" : "Enables experimental content to be developed following the same lifecycle that would be used for a production-level terminology capabilities.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TerminologyCapabilities.experimental",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.experimental"
},
{
"identity" : "w5",
"map" : "FiveWs.class"
}]
},
{
"id" : "TerminologyCapabilities.date",
"path" : "TerminologyCapabilities.date",
"short" : "Date last changed",
"definition" : "The date (and optionally time) when the terminology capabilities was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the terminology capabilities changes.",
"comment" : "Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the terminology capabilities. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.",
"alias" : ["Revision Date"],
"min" : 1,
"max" : "1",
"base" : {
"path" : "TerminologyCapabilities.date",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.date"
},
{
"identity" : "w5",
"map" : "FiveWs.recorded"
}]
},
{
"id" : "TerminologyCapabilities.publisher",
"path" : "TerminologyCapabilities.publisher",
"short" : "Name of the publisher (organization or individual)",
"definition" : "The name of the organization or individual that published the terminology capabilities.",
"comment" : "Usually an organization but may be an individual. The publisher (or steward) of the terminology capabilities is the organization or individual primarily responsible for the maintenance and upkeep of the terminology capabilities. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the terminology capabilities. This item SHOULD be populated unless the information is available from context.",
"requirements" : "Helps establish the \"authority/credibility\" of the terminology capabilities. May also allow for contact.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TerminologyCapabilities.publisher",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.publisher"
},
{
"identity" : "w5",
"map" : "FiveWs.witness"
}]
},
{
"id" : "TerminologyCapabilities.contact",
"path" : "TerminologyCapabilities.contact",
"short" : "Contact details for the publisher",
"definition" : "Contact details to assist a user in finding and communicating with the publisher.",
"comment" : "May be a web site, an email address, a telephone number, etc.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "TerminologyCapabilities.contact",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "ContactDetail"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.contact"
}]
},
{
"id" : "TerminologyCapabilities.description",
"path" : "TerminologyCapabilities.description",
"short" : "Natural language description of the terminology capabilities",
"definition" : "A free text natural language description of the terminology capabilities from a consumer's perspective. Typically, this is used when the capability statement describes a desired rather than an actual solution, for example as a formal expression of requirements as part of an RFP.",
"comment" : "This description can be used to capture details such as why the terminology capabilities was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the terminology capabilities as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the terminology capabilities is presumed to be the predominant language in the place the terminology capabilities was created).This does not need to be populated if the description is adequately implied by the software or implementation details.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TerminologyCapabilities.description",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "markdown"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.description"
}]
},
{
"id" : "TerminologyCapabilities.useContext",
"path" : "TerminologyCapabilities.useContext",
"short" : "The context that the content is intended to support",
"definition" : "The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate terminology capabilities instances.",
"comment" : "When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.",
"requirements" : "Assist in searching for appropriate content.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "TerminologyCapabilities.useContext",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "UsageContext"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.useContext"
}]
},
{
"id" : "TerminologyCapabilities.jurisdiction",
"path" : "TerminologyCapabilities.jurisdiction",
"short" : "Intended jurisdiction for terminology capabilities (if applicable)",
"definition" : "A legal or geographic region in which the terminology capabilities is intended to be used.",
"comment" : "It may be possible for the terminology capabilities to be used in jurisdictions other than those for which it was originally designed or intended.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "TerminologyCapabilities.jurisdiction",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Jurisdiction"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "extensible",
"description" : "Countries and regions within which this artifact is targeted for use.",
"valueSet" : "http://hl7.org/fhir/ValueSet/jurisdiction"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.jurisdiction"
}]
},
{
"id" : "TerminologyCapabilities.purpose",
"path" : "TerminologyCapabilities.purpose",
"short" : "Why this terminology capabilities is defined",
"definition" : "Explanation of why this terminology capabilities is needed and why it has been designed as it has.",
"comment" : "This element does not describe the usage of the terminology capabilities. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this terminology capabilities.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TerminologyCapabilities.purpose",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "markdown"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.purpose"
},
{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "TerminologyCapabilities.copyright",
"path" : "TerminologyCapabilities.copyright",
"short" : "Use and/or publishing restrictions",
"definition" : "A copyright statement relating to the terminology capabilities and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the terminology capabilities.",
"requirements" : "Consumers must be able to determine any legal restrictions on the use of the terminology capabilities and/or its content.",
"alias" : ["License",
"Restrictions"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "TerminologyCapabilities.copyright",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "markdown"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.copyright"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "TerminologyCapabilities.kind",
"path" : "TerminologyCapabilities.kind",
"short" : "instance | capability | requirements",
"definition" : "The way that this statement is intended to be used, to describe an actual running instance of software, a particular product (kind, not instance of software) or a class of implementation (e.g. a desired purchase).",
"requirements" : "Allow searching the 3 modes.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "TerminologyCapabilities.kind",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"condition" : ["tcp-3",
"tcp-4",
"tcp-5"],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "CapabilityStatementKind"
}],
"strength" : "required",
"description" : "How a capability statement is intended to be used.",
"valueSet" : "http://hl7.org/fhir/ValueSet/capability-statement-kind|4.0.1"
}
},
{
"id" : "TerminologyCapabilities.software",
"path" : "TerminologyCapabilities.software",
"short" : "Software that is covered by this terminology capability statement",
"definition" : "Software that is covered by this terminology capability statement. It is used when the statement describes the capabilities of a particular software version, independent of an installation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TerminologyCapabilities.software",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "BackboneElement"
}],
"condition" : ["tcp-2"],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "TerminologyCapabilities.software.id",
"path" : "TerminologyCapabilities.software.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "TerminologyCapabilities.software.extension",
"path" : "TerminologyCapabilities.software.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "TerminologyCapabilities.software.modifierExtension",
"path" : "TerminologyCapabilities.software.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "TerminologyCapabilities.software.name",
"path" : "TerminologyCapabilities.software.name",
"short" : "A name the software is known by",
"definition" : "Name the software is known by.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "TerminologyCapabilities.software.name",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "TerminologyCapabilities.software.version",
"path" : "TerminologyCapabilities.software.version",
"short" : "Version covered by this statement",
"definition" : "The version identifier for the software covered by this statement.",
"comment" : "If possible, a version should be specified, as statements are likely to be different for different versions of software.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TerminologyCapabilities.software.version",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "TerminologyCapabilities.implementation",
"path" : "TerminologyCapabilities.implementation",
"short" : "If this describes a specific instance",
"definition" : "Identifies a specific implementation instance that is described by the terminology capability statement - i.e. a particular installation, rather than the capabilities of a software program.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TerminologyCapabilities.implementation",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "BackboneElement"
}],
"condition" : ["tcp-2",
"tcp-5"],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "TerminologyCapabilities.implementation.id",
"path" : "TerminologyCapabilities.implementation.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "TerminologyCapabilities.implementation.extension",
"path" : "TerminologyCapabilities.implementation.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "TerminologyCapabilities.implementation.modifierExtension",
"path" : "TerminologyCapabilities.implementation.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "TerminologyCapabilities.implementation.description",
"path" : "TerminologyCapabilities.implementation.description",
"short" : "Describes this specific instance",
"definition" : "Information about the specific installation that this terminology capability statement relates to.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "TerminologyCapabilities.implementation.description",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "TerminologyCapabilities.implementation.url",
"path" : "TerminologyCapabilities.implementation.url",
"short" : "Base URL for the implementation",
"definition" : "An absolute base URL for the implementation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TerminologyCapabilities.implementation.url",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "url"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "TerminologyCapabilities.lockedDate",
"path" : "TerminologyCapabilities.lockedDate",
"short" : "Whether lockedDate is supported",
"definition" : "Whether the server supports lockedDate.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TerminologyCapabilities.lockedDate",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "TerminologyCapabilities.codeSystem",
"path" : "TerminologyCapabilities.codeSystem",
"short" : "A code system supported by the server",
"definition" : "Identifies a code system that is supported by the server. If there is a no code system URL, then this declares the general assumptions a client can make about support for any CodeSystem resource.",
"comment" : "The code system - identified by its system URL - may also be declared explicitly as a Code System Resource at /CodeSystem, but it might not be.",
"alias" : ["1"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "TerminologyCapabilities.codeSystem",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "tcp-1",
"severity" : "error",
"human" : "If there is more than one version, a version code must be defined",
"expression" : "version.count() > 1 implies version.all(code.exists())",
"xpath" : "(count(f:version) <= 1) or not(exists(f:version[not(f:code)]))"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TerminologyCapabilities.codeSystem.id",
"path" : "TerminologyCapabilities.codeSystem.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "TerminologyCapabilities.codeSystem.extension",
"path" : "TerminologyCapabilities.codeSystem.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "TerminologyCapabilities.codeSystem.modifierExtension",
"path" : "TerminologyCapabilities.codeSystem.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "TerminologyCapabilities.codeSystem.uri",
"path" : "TerminologyCapabilities.codeSystem.uri",
"short" : "URI for the Code System",
"definition" : "URI for the Code System.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TerminologyCapabilities.codeSystem.uri",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/CodeSystem"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TerminologyCapabilities.codeSystem.version",
"path" : "TerminologyCapabilities.codeSystem.version",
"short" : "Version of Code System supported",
"definition" : "For the code system, a list of versions that are supported by the server.",
"comment" : "Language translations might not be available for all codes.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "TerminologyCapabilities.codeSystem.version",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TerminologyCapabilities.codeSystem.version.id",
"path" : "TerminologyCapabilities.codeSystem.version.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "TerminologyCapabilities.codeSystem.version.extension",
"path" : "TerminologyCapabilities.codeSystem.version.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "TerminologyCapabilities.codeSystem.version.modifierExtension",
"path" : "TerminologyCapabilities.codeSystem.version.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "TerminologyCapabilities.codeSystem.version.code",
"path" : "TerminologyCapabilities.codeSystem.version.code",
"short" : "Version identifier for this version",
"definition" : "For version-less code systems, there should be a single version with no identifier.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TerminologyCapabilities.codeSystem.version.code",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"condition" : ["tcp-1"],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "TerminologyCapabilities.codeSystem.version.isDefault",
"path" : "TerminologyCapabilities.codeSystem.version.isDefault",
"short" : "If this is the default version for this code system",
"definition" : "If this is the default version for this code system.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TerminologyCapabilities.codeSystem.version.isDefault",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "TerminologyCapabilities.codeSystem.version.compositional",
"path" : "TerminologyCapabilities.codeSystem.version.compositional",
"short" : "If compositional grammar is supported",
"definition" : "If the compositional grammar defined by the code system is supported.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TerminologyCapabilities.codeSystem.version.compositional",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TerminologyCapabilities.codeSystem.version.language",
"path" : "TerminologyCapabilities.codeSystem.version.language",
"short" : "Language Displays supported",
"definition" : "Language Displays supported.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "TerminologyCapabilities.codeSystem.version.language",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TerminologyCapabilities.codeSystem.version.filter",
"path" : "TerminologyCapabilities.codeSystem.version.filter",
"short" : "Filter Properties supported",
"definition" : "Filter Properties supported.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "TerminologyCapabilities.codeSystem.version.filter",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TerminologyCapabilities.codeSystem.version.filter.id",
"path" : "TerminologyCapabilities.codeSystem.version.filter.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "TerminologyCapabilities.codeSystem.version.filter.extension",
"path" : "TerminologyCapabilities.codeSystem.version.filter.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "TerminologyCapabilities.codeSystem.version.filter.modifierExtension",
"path" : "TerminologyCapabilities.codeSystem.version.filter.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "TerminologyCapabilities.codeSystem.version.filter.code",
"path" : "TerminologyCapabilities.codeSystem.version.filter.code",
"short" : "Code of the property supported",
"definition" : "Code of the property supported.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "TerminologyCapabilities.codeSystem.version.filter.code",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TerminologyCapabilities.codeSystem.version.filter.op",
"path" : "TerminologyCapabilities.codeSystem.version.filter.op",
"short" : "Operations supported for the property",
"definition" : "Operations supported for the property.",
"min" : 1,
"max" : "*",
"base" : {
"path" : "TerminologyCapabilities.codeSystem.version.filter.op",
"min" : 1,
"max" : "*"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TerminologyCapabilities.codeSystem.version.property",
"path" : "TerminologyCapabilities.codeSystem.version.property",
"short" : "Properties supported for $lookup",
"definition" : "Properties supported for $lookup.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "TerminologyCapabilities.codeSystem.version.property",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TerminologyCapabilities.codeSystem.subsumption",
"path" : "TerminologyCapabilities.codeSystem.subsumption",
"short" : "Whether subsumption is supported",
"definition" : "True if subsumption is supported for this version of the code system.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TerminologyCapabilities.codeSystem.subsumption",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TerminologyCapabilities.expansion",
"path" : "TerminologyCapabilities.expansion",
"short" : "Information about the [ValueSet/$expand](valueset-operation-expand.html) operation",
"definition" : "Information about the [ValueSet/$expand](valueset-operation-expand.html) operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TerminologyCapabilities.expansion",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TerminologyCapabilities.expansion.id",
"path" : "TerminologyCapabilities.expansion.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "TerminologyCapabilities.expansion.extension",
"path" : "TerminologyCapabilities.expansion.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "TerminologyCapabilities.expansion.modifierExtension",
"path" : "TerminologyCapabilities.expansion.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "TerminologyCapabilities.expansion.hierarchical",
"path" : "TerminologyCapabilities.expansion.hierarchical",
"short" : "Whether the server can return nested value sets",
"definition" : "Whether the server can return nested value sets.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TerminologyCapabilities.expansion.hierarchical",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TerminologyCapabilities.expansion.paging",
"path" : "TerminologyCapabilities.expansion.paging",
"short" : "Whether the server supports paging on expansion",
"definition" : "Whether the server supports paging on expansion.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TerminologyCapabilities.expansion.paging",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TerminologyCapabilities.expansion.incomplete",
"path" : "TerminologyCapabilities.expansion.incomplete",
"short" : "Allow request for incomplete expansions?",
"definition" : "Allow request for incomplete expansions?",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TerminologyCapabilities.expansion.incomplete",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TerminologyCapabilities.expansion.parameter",
"path" : "TerminologyCapabilities.expansion.parameter",
"short" : "Supported expansion parameter",
"definition" : "Supported expansion parameter.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "TerminologyCapabilities.expansion.parameter",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TerminologyCapabilities.expansion.parameter.id",
"path" : "TerminologyCapabilities.expansion.parameter.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "TerminologyCapabilities.expansion.parameter.extension",
"path" : "TerminologyCapabilities.expansion.parameter.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "TerminologyCapabilities.expansion.parameter.modifierExtension",
"path" : "TerminologyCapabilities.expansion.parameter.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "TerminologyCapabilities.expansion.parameter.name",
"path" : "TerminologyCapabilities.expansion.parameter.name",
"short" : "Expansion Parameter name",
"definition" : "Expansion Parameter name.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "TerminologyCapabilities.expansion.parameter.name",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TerminologyCapabilities.expansion.parameter.documentation",
"path" : "TerminologyCapabilities.expansion.parameter.documentation",
"short" : "Description of support for parameter",
"definition" : "Description of support for parameter.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TerminologyCapabilities.expansion.parameter.documentation",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TerminologyCapabilities.expansion.textFilter",
"path" : "TerminologyCapabilities.expansion.textFilter",
"short" : "Documentation about text searching works",
"definition" : "Documentation about text searching works.",
"comment" : "This documentation should cover things like case sensitivity, use of punctuation if not ignored, what wild cards are supported (if any), whether text is starts with or contains, and whether word order matters.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TerminologyCapabilities.expansion.textFilter",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "markdown"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TerminologyCapabilities.codeSearch",
"path" : "TerminologyCapabilities.codeSearch",
"short" : "explicit | all",
"definition" : "The degree to which the server supports the code search parameter on ValueSet, if it is supported.",
"comment" : "See notes on the [ValueSet](valueset.html#) resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TerminologyCapabilities.codeSearch",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "CodeSearchSupport"
}],
"strength" : "required",
"description" : "The degree to which the server supports the code search parameter on ValueSet, if it is supported.",
"valueSet" : "http://hl7.org/fhir/ValueSet/code-search-support|4.0.1"
}
},
{
"id" : "TerminologyCapabilities.validateCode",
"path" : "TerminologyCapabilities.validateCode",
"short" : "Information about the [ValueSet/$validate-code](valueset-operation-validate-code.html) operation",
"definition" : "Information about the [ValueSet/$validate-code](valueset-operation-validate-code.html) operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TerminologyCapabilities.validateCode",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TerminologyCapabilities.validateCode.id",
"path" : "TerminologyCapabilities.validateCode.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "TerminologyCapabilities.validateCode.extension",
"path" : "TerminologyCapabilities.validateCode.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "TerminologyCapabilities.validateCode.modifierExtension",
"path" : "TerminologyCapabilities.validateCode.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "TerminologyCapabilities.validateCode.translations",
"path" : "TerminologyCapabilities.validateCode.translations",
"short" : "Whether translations are validated",
"definition" : "Whether translations are validated.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "TerminologyCapabilities.validateCode.translations",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TerminologyCapabilities.translation",
"path" : "TerminologyCapabilities.translation",
"short" : "Information about the [ConceptMap/$translate](conceptmap-operation-translate.html) operation",
"definition" : "Information about the [ConceptMap/$translate](conceptmap-operation-translate.html) operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TerminologyCapabilities.translation",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TerminologyCapabilities.translation.id",
"path" : "TerminologyCapabilities.translation.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "TerminologyCapabilities.translation.extension",
"path" : "TerminologyCapabilities.translation.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "TerminologyCapabilities.translation.modifierExtension",
"path" : "TerminologyCapabilities.translation.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "TerminologyCapabilities.translation.needsMap",
"path" : "TerminologyCapabilities.translation.needsMap",
"short" : "Whether the client must identify the map",
"definition" : "Whether the client must identify the map.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "TerminologyCapabilities.translation.needsMap",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TerminologyCapabilities.closure",
"path" : "TerminologyCapabilities.closure",
"short" : "Information about the [ConceptMap/$closure](conceptmap-operation-closure.html) operation",
"definition" : "Whether the $closure operation is supported.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TerminologyCapabilities.closure",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TerminologyCapabilities.closure.id",
"path" : "TerminologyCapabilities.closure.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "TerminologyCapabilities.closure.extension",
"path" : "TerminologyCapabilities.closure.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "TerminologyCapabilities.closure.modifierExtension",
"path" : "TerminologyCapabilities.closure.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "TerminologyCapabilities.closure.translation",
"path" : "TerminologyCapabilities.closure.translation",
"short" : "If cross-system closure is supported",
"definition" : "If cross-system closure is supported.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TerminologyCapabilities.closure.translation",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
}]
},
"differential" : {
"element" : [{
"id" : "TerminologyCapabilities",
"path" : "TerminologyCapabilities",
"short" : "A statement of system capabilities",
"definition" : "A TerminologyCapabilities resource documents a set of capabilities (behaviors) of a FHIR Terminology Server that may be used as a statement of actual server functionality or a statement of required or desired server implementation.",
"min" : 0,
"max" : "*",
"constraint" : [{
"key" : "tcp-0",
"severity" : "warning",
"human" : "Name should be usable as an identifier for the module by machine processing applications such as code generation",
"expression" : "name.matches('[A-Z]([A-Za-z0-9_]){0,254}')",
"xpath" : "not(exists(f:name/@value)) or matches(f:name/@value, '[A-Z]([A-Za-z0-9_]){0,254}')"
},
{
"key" : "tcp-3",
"severity" : "error",
"human" : "If kind = instance, implementation must be present and software may be present",
"expression" : "(kind != 'instance') or implementation.exists()",
"xpath" : "not(f:kind/@value='instance') or exists(f:implementation)"
},
{
"key" : "tcp-2",
"severity" : "error",
"human" : "A Capability Statement SHALL have at least one of description, software, or implementation element.",
"expression" : "(description.count() + software.count() + implementation.count()) > 0",
"xpath" : "count(f:software | f:implementation | f:description) > 0"
},
{
"key" : "tcp-5",
"severity" : "error",
"human" : "If kind = requirements, implementation and software must be absent",
"expression" : "(kind!='requirements') or (implementation.exists().not() and software.exists().not())",
"xpath" : "not(f:kind/@value='instance') or (not(exists(f:implementation)) and not(exists(f:software)))"
},
{
"key" : "tcp-4",
"severity" : "error",
"human" : "If kind = capability, implementation must be absent, software must be present",
"expression" : "(kind != 'capability') or (implementation.exists().not() and software.exists())",
"xpath" : " not(f:kind/@value='instance') or (not(exists(f:implementation)) and exists(f:software))"
}],
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "TerminologyCapabilities.url",
"path" : "TerminologyCapabilities.url",
"short" : "Canonical identifier for this terminology capabilities, represented as a URI (globally unique)",
"definition" : "An absolute URI that is used to identify this terminology capabilities when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this terminology capabilities is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the terminology capabilities is stored on different servers.",
"comment" : "Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.\n\nThe determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions). \n\nIn some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.",
"requirements" : "Allows the terminology capabilities to be referenced by a single globally unique identifier.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "uri"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.url"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
}]
},
{
"id" : "TerminologyCapabilities.version",
"path" : "TerminologyCapabilities.version",
"short" : "Business version of the terminology capabilities",
"definition" : "The identifier that is used to identify this version of the terminology capabilities when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the terminology capabilities author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.",
"comment" : "There may be different terminology capabilities instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the terminology capabilities with the format [url]|[version].",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.version"
},
{
"identity" : "w5",
"map" : "FiveWs.version"
}]
},
{
"id" : "TerminologyCapabilities.name",
"path" : "TerminologyCapabilities.name",
"short" : "Name for this terminology capabilities (computer friendly)",
"definition" : "A natural language name identifying the terminology capabilities. This name should be usable as an identifier for the module by machine processing applications such as code generation.",
"comment" : "The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.",
"requirements" : "Support human navigation and code generation.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"condition" : ["inv-0"],
"isSummary" : true
},
{
"id" : "TerminologyCapabilities.title",
"path" : "TerminologyCapabilities.title",
"short" : "Name for this terminology capabilities (human friendly)",
"definition" : "A short, descriptive, user-friendly title for the terminology capabilities.",
"comment" : "This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.title"
}]
},
{
"id" : "TerminologyCapabilities.status",
"path" : "TerminologyCapabilities.status",
"short" : "draft | active | retired | unknown",
"definition" : "The status of this terminology capabilities. Enables tracking the life-cycle of the content.",
"comment" : "Allows filtering of terminology capabilitiess that are appropriate for use versus not.This is not intended for use with actual capability statements, but where capability statements are used to describe possible or desired systems.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isModifier" : true,
"isModifierReason" : "This is labeled as \"Is Modifier\" because applications should not use a retired {{title}} without due consideration",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "PublicationStatus"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "The lifecycle status of an artifact.",
"valueSet" : "http://hl7.org/fhir/ValueSet/publication-status|4.0.1"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.status"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
}]
},
{
"id" : "TerminologyCapabilities.experimental",
"path" : "TerminologyCapabilities.experimental",
"short" : "For testing purposes, not real usage",
"definition" : "A Boolean value to indicate that this terminology capabilities is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.",
"comment" : "Allows filtering of terminology capabilitiess that are appropriate for use versus not.",
"requirements" : "Enables experimental content to be developed following the same lifecycle that would be used for a production-level terminology capabilities.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "boolean"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.experimental"
},
{
"identity" : "w5",
"map" : "FiveWs.class"
}]
},
{
"id" : "TerminologyCapabilities.date",
"path" : "TerminologyCapabilities.date",
"short" : "Date last changed",
"definition" : "The date (and optionally time) when the terminology capabilities was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the terminology capabilities changes.",
"comment" : "Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the terminology capabilities. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.",
"alias" : ["Revision Date"],
"min" : 1,
"max" : "1",
"type" : [{
"code" : "dateTime"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.date"
},
{
"identity" : "w5",
"map" : "FiveWs.recorded"
}]
},
{
"id" : "TerminologyCapabilities.publisher",
"path" : "TerminologyCapabilities.publisher",
"short" : "Name of the publisher (organization or individual)",
"definition" : "The name of the organization or individual that published the terminology capabilities.",
"comment" : "Usually an organization but may be an individual. The publisher (or steward) of the terminology capabilities is the organization or individual primarily responsible for the maintenance and upkeep of the terminology capabilities. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the terminology capabilities. This item SHOULD be populated unless the information is available from context.",
"requirements" : "Helps establish the \"authority/credibility\" of the terminology capabilities. May also allow for contact.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.publisher"
},
{
"identity" : "w5",
"map" : "FiveWs.witness"
}]
},
{
"id" : "TerminologyCapabilities.contact",
"path" : "TerminologyCapabilities.contact",
"short" : "Contact details for the publisher",
"definition" : "Contact details to assist a user in finding and communicating with the publisher.",
"comment" : "May be a web site, an email address, a telephone number, etc.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "ContactDetail"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.contact"
}]
},
{
"id" : "TerminologyCapabilities.description",
"path" : "TerminologyCapabilities.description",
"short" : "Natural language description of the terminology capabilities",
"definition" : "A free text natural language description of the terminology capabilities from a consumer's perspective. Typically, this is used when the capability statement describes a desired rather than an actual solution, for example as a formal expression of requirements as part of an RFP.",
"comment" : "This description can be used to capture details such as why the terminology capabilities was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the terminology capabilities as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the terminology capabilities is presumed to be the predominant language in the place the terminology capabilities was created).This does not need to be populated if the description is adequately implied by the software or implementation details.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "markdown"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.description"
}]
},
{
"id" : "TerminologyCapabilities.useContext",
"path" : "TerminologyCapabilities.useContext",
"short" : "The context that the content is intended to support",
"definition" : "The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate terminology capabilities instances.",
"comment" : "When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.",
"requirements" : "Assist in searching for appropriate content.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "UsageContext"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.useContext"
}]
},
{
"id" : "TerminologyCapabilities.jurisdiction",
"path" : "TerminologyCapabilities.jurisdiction",
"short" : "Intended jurisdiction for terminology capabilities (if applicable)",
"definition" : "A legal or geographic region in which the terminology capabilities is intended to be used.",
"comment" : "It may be possible for the terminology capabilities to be used in jurisdictions other than those for which it was originally designed or intended.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Jurisdiction"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "extensible",
"description" : "Countries and regions within which this artifact is targeted for use.",
"valueSet" : "http://hl7.org/fhir/ValueSet/jurisdiction"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.jurisdiction"
}]
},
{
"id" : "TerminologyCapabilities.purpose",
"path" : "TerminologyCapabilities.purpose",
"short" : "Why this terminology capabilities is defined",
"definition" : "Explanation of why this terminology capabilities is needed and why it has been designed as it has.",
"comment" : "This element does not describe the usage of the terminology capabilities. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this terminology capabilities.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "markdown"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.purpose"
},
{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "TerminologyCapabilities.copyright",
"path" : "TerminologyCapabilities.copyright",
"short" : "Use and/or publishing restrictions",
"definition" : "A copyright statement relating to the terminology capabilities and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the terminology capabilities.",
"requirements" : "Consumers must be able to determine any legal restrictions on the use of the terminology capabilities and/or its content.",
"alias" : ["License",
"Restrictions"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "markdown"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.copyright"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "TerminologyCapabilities.kind",
"path" : "TerminologyCapabilities.kind",
"short" : "instance | capability | requirements",
"definition" : "The way that this statement is intended to be used, to describe an actual running instance of software, a particular product (kind, not instance of software) or a class of implementation (e.g. a desired purchase).",
"requirements" : "Allow searching the 3 modes.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"condition" : ["tcp-3",
"tcp-4",
"tcp-5"],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "CapabilityStatementKind"
}],
"strength" : "required",
"description" : "How a capability statement is intended to be used.",
"valueSet" : "http://hl7.org/fhir/ValueSet/capability-statement-kind|4.0.1"
}
},
{
"id" : "TerminologyCapabilities.software",
"path" : "TerminologyCapabilities.software",
"short" : "Software that is covered by this terminology capability statement",
"definition" : "Software that is covered by this terminology capability statement. It is used when the statement describes the capabilities of a particular software version, independent of an installation.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "BackboneElement"
}],
"condition" : ["tcp-2"],
"isSummary" : true
},
{
"id" : "TerminologyCapabilities.software.name",
"path" : "TerminologyCapabilities.software.name",
"short" : "A name the software is known by",
"definition" : "Name the software is known by.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "TerminologyCapabilities.software.version",
"path" : "TerminologyCapabilities.software.version",
"short" : "Version covered by this statement",
"definition" : "The version identifier for the software covered by this statement.",
"comment" : "If possible, a version should be specified, as statements are likely to be different for different versions of software.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "TerminologyCapabilities.implementation",
"path" : "TerminologyCapabilities.implementation",
"short" : "If this describes a specific instance",
"definition" : "Identifies a specific implementation instance that is described by the terminology capability statement - i.e. a particular installation, rather than the capabilities of a software program.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "BackboneElement"
}],
"condition" : ["tcp-2",
"tcp-5"],
"isSummary" : true
},
{
"id" : "TerminologyCapabilities.implementation.description",
"path" : "TerminologyCapabilities.implementation.description",
"short" : "Describes this specific instance",
"definition" : "Information about the specific installation that this terminology capability statement relates to.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "TerminologyCapabilities.implementation.url",
"path" : "TerminologyCapabilities.implementation.url",
"short" : "Base URL for the implementation",
"definition" : "An absolute base URL for the implementation.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "url"
}],
"isSummary" : true
},
{
"id" : "TerminologyCapabilities.lockedDate",
"path" : "TerminologyCapabilities.lockedDate",
"short" : "Whether lockedDate is supported",
"definition" : "Whether the server supports lockedDate.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "boolean"
}],
"isSummary" : true
},
{
"id" : "TerminologyCapabilities.codeSystem",
"path" : "TerminologyCapabilities.codeSystem",
"short" : "A code system supported by the server",
"definition" : "Identifies a code system that is supported by the server. If there is a no code system URL, then this declares the general assumptions a client can make about support for any CodeSystem resource.",
"comment" : "The code system - identified by its system URL - may also be declared explicitly as a Code System Resource at /CodeSystem, but it might not be.",
"alias" : ["1"],
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "tcp-1",
"severity" : "error",
"human" : "If there is more than one version, a version code must be defined",
"expression" : "version.count() > 1 implies version.all(code.exists())",
"xpath" : "(count(f:version) <= 1) or not(exists(f:version[not(f:code)]))"
}]
},
{
"id" : "TerminologyCapabilities.codeSystem.uri",
"path" : "TerminologyCapabilities.codeSystem.uri",
"short" : "URI for the Code System",
"definition" : "URI for the Code System.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/CodeSystem"]
}]
},
{
"id" : "TerminologyCapabilities.codeSystem.version",
"path" : "TerminologyCapabilities.codeSystem.version",
"short" : "Version of Code System supported",
"definition" : "For the code system, a list of versions that are supported by the server.",
"comment" : "Language translations might not be available for all codes.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "TerminologyCapabilities.codeSystem.version.code",
"path" : "TerminologyCapabilities.codeSystem.version.code",
"short" : "Version identifier for this version",
"definition" : "For version-less code systems, there should be a single version with no identifier.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"condition" : ["tcp-1"],
"isSummary" : true
},
{
"id" : "TerminologyCapabilities.codeSystem.version.isDefault",
"path" : "TerminologyCapabilities.codeSystem.version.isDefault",
"short" : "If this is the default version for this code system",
"definition" : "If this is the default version for this code system.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "boolean"
}],
"isSummary" : true
},
{
"id" : "TerminologyCapabilities.codeSystem.version.compositional",
"path" : "TerminologyCapabilities.codeSystem.version.compositional",
"short" : "If compositional grammar is supported",
"definition" : "If the compositional grammar defined by the code system is supported.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "boolean"
}]
},
{
"id" : "TerminologyCapabilities.codeSystem.version.language",
"path" : "TerminologyCapabilities.codeSystem.version.language",
"short" : "Language Displays supported",
"definition" : "Language Displays supported.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "code"
}]
},
{
"id" : "TerminologyCapabilities.codeSystem.version.filter",
"path" : "TerminologyCapabilities.codeSystem.version.filter",
"short" : "Filter Properties supported",
"definition" : "Filter Properties supported.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "TerminologyCapabilities.codeSystem.version.filter.code",
"path" : "TerminologyCapabilities.codeSystem.version.filter.code",
"short" : "Code of the property supported",
"definition" : "Code of the property supported.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}]
},
{
"id" : "TerminologyCapabilities.codeSystem.version.filter.op",
"path" : "TerminologyCapabilities.codeSystem.version.filter.op",
"short" : "Operations supported for the property",
"definition" : "Operations supported for the property.",
"min" : 1,
"max" : "*",
"type" : [{
"code" : "code"
}]
},
{
"id" : "TerminologyCapabilities.codeSystem.version.property",
"path" : "TerminologyCapabilities.codeSystem.version.property",
"short" : "Properties supported for $lookup",
"definition" : "Properties supported for $lookup.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "code"
}]
},
{
"id" : "TerminologyCapabilities.codeSystem.subsumption",
"path" : "TerminologyCapabilities.codeSystem.subsumption",
"short" : "Whether subsumption is supported",
"definition" : "True if subsumption is supported for this version of the code system.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "boolean"
}]
},
{
"id" : "TerminologyCapabilities.expansion",
"path" : "TerminologyCapabilities.expansion",
"short" : "Information about the [ValueSet/$expand](valueset-operation-expand.html) operation",
"definition" : "Information about the [ValueSet/$expand](valueset-operation-expand.html) operation.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "TerminologyCapabilities.expansion.hierarchical",
"path" : "TerminologyCapabilities.expansion.hierarchical",
"short" : "Whether the server can return nested value sets",
"definition" : "Whether the server can return nested value sets.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "boolean"
}]
},
{
"id" : "TerminologyCapabilities.expansion.paging",
"path" : "TerminologyCapabilities.expansion.paging",
"short" : "Whether the server supports paging on expansion",
"definition" : "Whether the server supports paging on expansion.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "boolean"
}]
},
{
"id" : "TerminologyCapabilities.expansion.incomplete",
"path" : "TerminologyCapabilities.expansion.incomplete",
"short" : "Allow request for incomplete expansions?",
"definition" : "Allow request for incomplete expansions?",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "boolean"
}]
},
{
"id" : "TerminologyCapabilities.expansion.parameter",
"path" : "TerminologyCapabilities.expansion.parameter",
"short" : "Supported expansion parameter",
"definition" : "Supported expansion parameter.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "TerminologyCapabilities.expansion.parameter.name",
"path" : "TerminologyCapabilities.expansion.parameter.name",
"short" : "Expansion Parameter name",
"definition" : "Expansion Parameter name.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}]
},
{
"id" : "TerminologyCapabilities.expansion.parameter.documentation",
"path" : "TerminologyCapabilities.expansion.parameter.documentation",
"short" : "Description of support for parameter",
"definition" : "Description of support for parameter.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}]
},
{
"id" : "TerminologyCapabilities.expansion.textFilter",
"path" : "TerminologyCapabilities.expansion.textFilter",
"short" : "Documentation about text searching works",
"definition" : "Documentation about text searching works.",
"comment" : "This documentation should cover things like case sensitivity, use of punctuation if not ignored, what wild cards are supported (if any), whether text is starts with or contains, and whether word order matters.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "markdown"
}]
},
{
"id" : "TerminologyCapabilities.codeSearch",
"path" : "TerminologyCapabilities.codeSearch",
"short" : "explicit | all",
"definition" : "The degree to which the server supports the code search parameter on ValueSet, if it is supported.",
"comment" : "See notes on the [ValueSet](valueset.html#) resource.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "code"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "CodeSearchSupport"
}],
"strength" : "required",
"description" : "The degree to which the server supports the code search parameter on ValueSet, if it is supported.",
"valueSet" : "http://hl7.org/fhir/ValueSet/code-search-support|4.0.1"
}
},
{
"id" : "TerminologyCapabilities.validateCode",
"path" : "TerminologyCapabilities.validateCode",
"short" : "Information about the [ValueSet/$validate-code](valueset-operation-validate-code.html) operation",
"definition" : "Information about the [ValueSet/$validate-code](valueset-operation-validate-code.html) operation.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "TerminologyCapabilities.validateCode.translations",
"path" : "TerminologyCapabilities.validateCode.translations",
"short" : "Whether translations are validated",
"definition" : "Whether translations are validated.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "boolean"
}]
},
{
"id" : "TerminologyCapabilities.translation",
"path" : "TerminologyCapabilities.translation",
"short" : "Information about the [ConceptMap/$translate](conceptmap-operation-translate.html) operation",
"definition" : "Information about the [ConceptMap/$translate](conceptmap-operation-translate.html) operation.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "TerminologyCapabilities.translation.needsMap",
"path" : "TerminologyCapabilities.translation.needsMap",
"short" : "Whether the client must identify the map",
"definition" : "Whether the client must identify the map.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "boolean"
}]
},
{
"id" : "TerminologyCapabilities.closure",
"path" : "TerminologyCapabilities.closure",
"short" : "Information about the [ConceptMap/$closure](conceptmap-operation-closure.html) operation",
"definition" : "Whether the $closure operation is supported.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "TerminologyCapabilities.closure.translation",
"path" : "TerminologyCapabilities.closure.translation",
"short" : "If cross-system closure is supported",
"definition" : "If cross-system closure is supported.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "boolean"
}]
}]
}
}
},
{
"fullUrl" : "http://hl7.org/fhir/StructureDefinition/TestReport",
"resource" : {
"resourceType" : "StructureDefinition",
"id" : "TestReport",
"meta" : {
"lastUpdated" : "2019-11-01T09:29:23.356+11:00"
},
"text" : {
"status" : "generated",
"div" : "Name Flags Card. Type Description & Constraints TestReport TU DomainResource Describes the results of a TestScript execution
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension identifier Σ 0..1 Identifier External identifier name Σ 0..1 string Informal name of the executed TestScript status ?!Σ 1..1 code completed | in-progress | waiting | stopped | entered-in-error
TestReportStatus (Required) testScript Σ 1..1 Reference(TestScript) Reference to the version-specific TestScript that was executed to produce this TestReport result Σ 1..1 code pass | fail | pending
TestReportResult (Required) score Σ 0..1 decimal The final score (percentage of tests passed) resulting from the execution of the TestScript tester Σ 0..1 string Name of the tester producing this report (Organization or individual) issued Σ 0..1 dateTime When the TestScript was executed and this TestReport was generated participant 0..* BackboneElement A participant in the test execution, either the execution engine, a client, or a server
type 1..1 code test-engine | client | server
TestReportParticipantType (Required) uri 1..1 uri The uri of the participant. An absolute URL is preferred display 0..1 string The display name of the participant setup 0..1 BackboneElement The results of the series of required setup operations before the tests were executed action I 1..* BackboneElement A setup operation or assert that was executed
+ Rule: Setup action SHALL contain either an operation or assert but not both.
operation 0..1 BackboneElement The operation to perform result 1..1 code pass | skip | fail | warning | error
TestReportActionResult (Required) message 0..1 markdown A message associated with the result detail 0..1 uri A link to further details on the result assert 0..1 BackboneElement The assertion to perform result 1..1 code pass | skip | fail | warning | error
TestReportActionResult (Required) message 0..1 markdown A message associated with the result detail 0..1 string A link to further details on the result test 0..* BackboneElement A test executed from the test script
name 0..1 string Tracking/logging name of this test description 0..1 string Tracking/reporting short description of the test action I 1..* BackboneElement A test operation or assert that was performed
+ Rule: Test action SHALL contain either an operation or assert but not both.
operation 0..1 see operation The operation performed assert 0..1 see assert The assertion performed teardown 0..1 BackboneElement The results of running the series of required clean up steps action 1..* BackboneElement One or more teardown operations performed
operation 1..1 see operation The teardown operation performed
Documentation for this format
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Specialized.Quality Reporting & Testing"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 0
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "business"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "fhir"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/TestReport",
"version" : "4.0.1",
"name" : "TestReport",
"status" : "draft",
"date" : "2019-11-01T09:29:23+11:00",
"publisher" : "Health Level Seven International (FHIR Infrastructure)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/fiwg/index.cfm"
}]
}],
"description" : "A summary of information based on the results of executing a TestScript.",
"fhirVersion" : "4.0.1",
"mapping" : [{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
},
{
"identity" : "objimpl",
"uri" : "http://hl7.org/fhir/object-implementation",
"name" : "Object Implementation Information"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/fivews",
"name" : "FiveWs Pattern Mapping"
}],
"kind" : "resource",
"abstract" : false,
"type" : "TestReport",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "TestReport",
"path" : "TestReport",
"short" : "Describes the results of a TestScript execution",
"definition" : "A summary of information based on the results of executing a TestScript.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "TestReport",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "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",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.`div`.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "objimpl",
"map" : "BaseConformance"
}]
},
{
"id" : "TestReport.id",
"path" : "TestReport.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "TestReport.meta",
"path" : "TestReport.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "TestReport.implicitRules",
"path" : "TestReport.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "TestReport.language",
"path" : "TestReport.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "TestReport.text",
"path" : "TestReport.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "TestReport.contained",
"path" : "TestReport.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "TestReport.extension",
"path" : "TestReport.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "TestReport.modifierExtension",
"path" : "TestReport.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "TestReport.identifier",
"path" : "TestReport.identifier",
"short" : "External identifier",
"definition" : "Identifier for the TestScript assigned for external purposes outside the context of FHIR.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TestReport.identifier",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Identifier"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.identifier"
}]
},
{
"id" : "TestReport.name",
"path" : "TestReport.name",
"short" : "Informal name of the executed TestScript",
"definition" : "A free text natural language name identifying the executed TestScript.",
"comment" : "Not expected to be globally unique.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TestReport.name",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "objimpl",
"map" : "BaseConformance.name"
}]
},
{
"id" : "TestReport.status",
"path" : "TestReport.status",
"short" : "completed | in-progress | waiting | stopped | entered-in-error",
"definition" : "The current state of this test report.",
"comment" : "The status represents where the execution is currently within the test script execution life cycle.\n\nThis element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "TestReport.status",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "TestReportStatus"
}],
"strength" : "required",
"description" : "The current status of the test report.",
"valueSet" : "http://hl7.org/fhir/ValueSet/report-status-codes|4.0.1"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.status"
}]
},
{
"id" : "TestReport.testScript",
"path" : "TestReport.testScript",
"short" : "Reference to the version-specific TestScript that was executed to produce this TestReport",
"definition" : "Ideally this is an absolute URL that is used to identify the version-specific TestScript that was executed, matching the `TestScript.url`.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "TestReport.testScript",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/TestScript"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "TestReport.result",
"path" : "TestReport.result",
"short" : "pass | fail | pending",
"definition" : "The overall result from the execution of the TestScript.",
"comment" : "The pass and fail result represents a completed test script execution. The pending result represents a test script execution that has not yet started or is currently in progress.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "TestReport.result",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "TestReportResult"
}],
"strength" : "required",
"description" : "The reported execution result.",
"valueSet" : "http://hl7.org/fhir/ValueSet/report-result-codes|4.0.1"
}
},
{
"id" : "TestReport.score",
"path" : "TestReport.score",
"short" : "The final score (percentage of tests passed) resulting from the execution of the TestScript",
"definition" : "The final score (percentage of tests passed) resulting from the execution of the TestScript.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TestReport.score",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "decimal"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "TestReport.tester",
"path" : "TestReport.tester",
"short" : "Name of the tester producing this report (Organization or individual)",
"definition" : "Name of the tester producing this report (Organization or individual).",
"comment" : "Usually an organization, but may be an individual. This item SHOULD be populated unless the information is available from context.",
"requirements" : "Helps establish the \"authority/credibility\" of the TestReport. May also allow for contact.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TestReport.tester",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "TestReport.issued",
"path" : "TestReport.issued",
"short" : "When the TestScript was executed and this TestReport was generated",
"definition" : "When the TestScript was executed and this TestReport was generated.",
"comment" : "Additional specific dates may be added as extensions.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TestReport.issued",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.recorded"
},
{
"identity" : "objimpl",
"map" : "BaseConformance.date"
}]
},
{
"id" : "TestReport.participant",
"path" : "TestReport.participant",
"short" : "A participant in the test execution, either the execution engine, a client, or a server",
"definition" : "A participant in the test execution, either the execution engine, a client, or a server.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "TestReport.participant",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TestReport.participant.id",
"path" : "TestReport.participant.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "TestReport.participant.extension",
"path" : "TestReport.participant.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "TestReport.participant.modifierExtension",
"path" : "TestReport.participant.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "TestReport.participant.type",
"path" : "TestReport.participant.type",
"short" : "test-engine | client | server",
"definition" : "The type of participant.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "TestReport.participant.type",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "TestReportParticipantType"
}],
"strength" : "required",
"description" : "The type of participant.",
"valueSet" : "http://hl7.org/fhir/ValueSet/report-participant-type|4.0.1"
}
},
{
"id" : "TestReport.participant.uri",
"path" : "TestReport.participant.uri",
"short" : "The uri of the participant. An absolute URL is preferred",
"definition" : "The uri of the participant. An absolute URL is preferred.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "TestReport.participant.uri",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TestReport.participant.display",
"path" : "TestReport.participant.display",
"short" : "The display name of the participant",
"definition" : "The display name of the participant.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TestReport.participant.display",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TestReport.setup",
"path" : "TestReport.setup",
"short" : "The results of the series of required setup operations before the tests were executed",
"definition" : "The results of the series of required setup operations before the tests were executed.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TestReport.setup",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TestReport.setup.id",
"path" : "TestReport.setup.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "TestReport.setup.extension",
"path" : "TestReport.setup.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "TestReport.setup.modifierExtension",
"path" : "TestReport.setup.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "TestReport.setup.action",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "SetupAction"
}],
"path" : "TestReport.setup.action",
"short" : "A setup operation or assert that was executed",
"definition" : "Action would contain either an operation or an assertion.",
"comment" : "An action should contain either an operation or an assertion but not both. It can contain any number of variables.",
"min" : 1,
"max" : "*",
"base" : {
"path" : "TestReport.setup.action",
"min" : 1,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "inv-1",
"severity" : "error",
"human" : "Setup action SHALL contain either an operation or assert but not both.",
"expression" : "operation.exists() xor assert.exists()",
"xpath" : "(f:operation or f:assert) and not(f:operation and f:assert)"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TestReport.setup.action.id",
"path" : "TestReport.setup.action.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "TestReport.setup.action.extension",
"path" : "TestReport.setup.action.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "TestReport.setup.action.modifierExtension",
"path" : "TestReport.setup.action.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "TestReport.setup.action.operation",
"path" : "TestReport.setup.action.operation",
"short" : "The operation to perform",
"definition" : "The operation performed.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TestReport.setup.action.operation",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TestReport.setup.action.operation.id",
"path" : "TestReport.setup.action.operation.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "TestReport.setup.action.operation.extension",
"path" : "TestReport.setup.action.operation.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "TestReport.setup.action.operation.modifierExtension",
"path" : "TestReport.setup.action.operation.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "TestReport.setup.action.operation.result",
"path" : "TestReport.setup.action.operation.result",
"short" : "pass | skip | fail | warning | error",
"definition" : "The result of this operation.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "TestReport.setup.action.operation.result",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "TestReportActionResult"
}],
"strength" : "required",
"description" : "The results of executing an action.",
"valueSet" : "http://hl7.org/fhir/ValueSet/report-action-result-codes|4.0.1"
}
},
{
"id" : "TestReport.setup.action.operation.message",
"path" : "TestReport.setup.action.operation.message",
"short" : "A message associated with the result",
"definition" : "An explanatory message associated with the result.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TestReport.setup.action.operation.message",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "markdown"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TestReport.setup.action.operation.detail",
"path" : "TestReport.setup.action.operation.detail",
"short" : "A link to further details on the result",
"definition" : "A link to further details on the result.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TestReport.setup.action.operation.detail",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TestReport.setup.action.assert",
"path" : "TestReport.setup.action.assert",
"short" : "The assertion to perform",
"definition" : "The results of the assertion performed on the previous operations.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TestReport.setup.action.assert",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TestReport.setup.action.assert.id",
"path" : "TestReport.setup.action.assert.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "TestReport.setup.action.assert.extension",
"path" : "TestReport.setup.action.assert.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "TestReport.setup.action.assert.modifierExtension",
"path" : "TestReport.setup.action.assert.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "TestReport.setup.action.assert.result",
"path" : "TestReport.setup.action.assert.result",
"short" : "pass | skip | fail | warning | error",
"definition" : "The result of this assertion.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "TestReport.setup.action.assert.result",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "TestReportActionResult"
}],
"strength" : "required",
"description" : "The results of executing an action.",
"valueSet" : "http://hl7.org/fhir/ValueSet/report-action-result-codes|4.0.1"
}
},
{
"id" : "TestReport.setup.action.assert.message",
"path" : "TestReport.setup.action.assert.message",
"short" : "A message associated with the result",
"definition" : "An explanatory message associated with the result.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TestReport.setup.action.assert.message",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "markdown"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TestReport.setup.action.assert.detail",
"path" : "TestReport.setup.action.assert.detail",
"short" : "A link to further details on the result",
"definition" : "A link to further details on the result.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TestReport.setup.action.assert.detail",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TestReport.test",
"path" : "TestReport.test",
"short" : "A test executed from the test script",
"definition" : "A test executed from the test script.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "TestReport.test",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TestReport.test.id",
"path" : "TestReport.test.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "TestReport.test.extension",
"path" : "TestReport.test.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "TestReport.test.modifierExtension",
"path" : "TestReport.test.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "TestReport.test.name",
"path" : "TestReport.test.name",
"short" : "Tracking/logging name of this test",
"definition" : "The name of this test used for tracking/logging purposes by test engines.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TestReport.test.name",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TestReport.test.description",
"path" : "TestReport.test.description",
"short" : "Tracking/reporting short description of the test",
"definition" : "A short description of the test used by test engines for tracking and reporting purposes.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TestReport.test.description",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TestReport.test.action",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "TestAction"
}],
"path" : "TestReport.test.action",
"short" : "A test operation or assert that was performed",
"definition" : "Action would contain either an operation or an assertion.",
"comment" : "An action should contain either an operation or an assertion but not both. It can contain any number of variables.",
"min" : 1,
"max" : "*",
"base" : {
"path" : "TestReport.test.action",
"min" : 1,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "inv-2",
"severity" : "error",
"human" : "Test action SHALL contain either an operation or assert but not both.",
"expression" : "operation.exists() xor assert.exists()",
"xpath" : "(f:operation or f:assert) and not(f:operation and f:assert)"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TestReport.test.action.id",
"path" : "TestReport.test.action.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "TestReport.test.action.extension",
"path" : "TestReport.test.action.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "TestReport.test.action.modifierExtension",
"path" : "TestReport.test.action.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "TestReport.test.action.operation",
"path" : "TestReport.test.action.operation",
"short" : "The operation performed",
"definition" : "An operation would involve a REST request to a server.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TestReport.test.action.operation",
"min" : 0,
"max" : "1"
},
"contentReference" : "#TestReport.setup.action.operation",
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TestReport.test.action.assert",
"path" : "TestReport.test.action.assert",
"short" : "The assertion performed",
"definition" : "The results of the assertion performed on the previous operations.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TestReport.test.action.assert",
"min" : 0,
"max" : "1"
},
"contentReference" : "#TestReport.setup.action.assert",
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TestReport.teardown",
"path" : "TestReport.teardown",
"short" : "The results of running the series of required clean up steps",
"definition" : "The results of the series of operations required to clean up after all the tests were executed (successfully or otherwise).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TestReport.teardown",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TestReport.teardown.id",
"path" : "TestReport.teardown.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "TestReport.teardown.extension",
"path" : "TestReport.teardown.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "TestReport.teardown.modifierExtension",
"path" : "TestReport.teardown.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "TestReport.teardown.action",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "TeardownAction"
}],
"path" : "TestReport.teardown.action",
"short" : "One or more teardown operations performed",
"definition" : "The teardown action will only contain an operation.",
"comment" : "An action should contain either an operation or an assertion but not both. It can contain any number of variables.",
"min" : 1,
"max" : "*",
"base" : {
"path" : "TestReport.teardown.action",
"min" : 1,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TestReport.teardown.action.id",
"path" : "TestReport.teardown.action.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "TestReport.teardown.action.extension",
"path" : "TestReport.teardown.action.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "TestReport.teardown.action.modifierExtension",
"path" : "TestReport.teardown.action.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "TestReport.teardown.action.operation",
"path" : "TestReport.teardown.action.operation",
"short" : "The teardown operation performed",
"definition" : "An operation would involve a REST request to a server.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "TestReport.teardown.action.operation",
"min" : 1,
"max" : "1"
},
"contentReference" : "#TestReport.setup.action.operation",
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
}]
},
"differential" : {
"element" : [{
"id" : "TestReport",
"path" : "TestReport",
"short" : "Describes the results of a TestScript execution",
"definition" : "A summary of information based on the results of executing a TestScript.",
"min" : 0,
"max" : "*",
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "objimpl",
"map" : "BaseConformance"
}]
},
{
"id" : "TestReport.identifier",
"path" : "TestReport.identifier",
"short" : "External identifier",
"definition" : "Identifier for the TestScript assigned for external purposes outside the context of FHIR.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Identifier"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.identifier"
}]
},
{
"id" : "TestReport.name",
"path" : "TestReport.name",
"short" : "Informal name of the executed TestScript",
"definition" : "A free text natural language name identifying the executed TestScript.",
"comment" : "Not expected to be globally unique.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "objimpl",
"map" : "BaseConformance.name"
}]
},
{
"id" : "TestReport.status",
"path" : "TestReport.status",
"short" : "completed | in-progress | waiting | stopped | entered-in-error",
"definition" : "The current state of this test report.",
"comment" : "The status represents where the execution is currently within the test script execution life cycle.\n\nThis element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isModifier" : true,
"isModifierReason" : "This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "TestReportStatus"
}],
"strength" : "required",
"description" : "The current status of the test report.",
"valueSet" : "http://hl7.org/fhir/ValueSet/report-status-codes|4.0.1"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.status"
}]
},
{
"id" : "TestReport.testScript",
"path" : "TestReport.testScript",
"short" : "Reference to the version-specific TestScript that was executed to produce this TestReport",
"definition" : "Ideally this is an absolute URL that is used to identify the version-specific TestScript that was executed, matching the `TestScript.url`.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/TestScript"]
}],
"isSummary" : true
},
{
"id" : "TestReport.result",
"path" : "TestReport.result",
"short" : "pass | fail | pending",
"definition" : "The overall result from the execution of the TestScript.",
"comment" : "The pass and fail result represents a completed test script execution. The pending result represents a test script execution that has not yet started or is currently in progress.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "TestReportResult"
}],
"strength" : "required",
"description" : "The reported execution result.",
"valueSet" : "http://hl7.org/fhir/ValueSet/report-result-codes|4.0.1"
}
},
{
"id" : "TestReport.score",
"path" : "TestReport.score",
"short" : "The final score (percentage of tests passed) resulting from the execution of the TestScript",
"definition" : "The final score (percentage of tests passed) resulting from the execution of the TestScript.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "decimal"
}],
"isSummary" : true
},
{
"id" : "TestReport.tester",
"path" : "TestReport.tester",
"short" : "Name of the tester producing this report (Organization or individual)",
"definition" : "Name of the tester producing this report (Organization or individual).",
"comment" : "Usually an organization, but may be an individual. This item SHOULD be populated unless the information is available from context.",
"requirements" : "Helps establish the \"authority/credibility\" of the TestReport. May also allow for contact.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "TestReport.issued",
"path" : "TestReport.issued",
"short" : "When the TestScript was executed and this TestReport was generated",
"definition" : "When the TestScript was executed and this TestReport was generated.",
"comment" : "Additional specific dates may be added as extensions.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "dateTime"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.recorded"
},
{
"identity" : "objimpl",
"map" : "BaseConformance.date"
}]
},
{
"id" : "TestReport.participant",
"path" : "TestReport.participant",
"short" : "A participant in the test execution, either the execution engine, a client, or a server",
"definition" : "A participant in the test execution, either the execution engine, a client, or a server.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "TestReport.participant.type",
"path" : "TestReport.participant.type",
"short" : "test-engine | client | server",
"definition" : "The type of participant.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "TestReportParticipantType"
}],
"strength" : "required",
"description" : "The type of participant.",
"valueSet" : "http://hl7.org/fhir/ValueSet/report-participant-type|4.0.1"
}
},
{
"id" : "TestReport.participant.uri",
"path" : "TestReport.participant.uri",
"short" : "The uri of the participant. An absolute URL is preferred",
"definition" : "The uri of the participant. An absolute URL is preferred.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "uri"
}]
},
{
"id" : "TestReport.participant.display",
"path" : "TestReport.participant.display",
"short" : "The display name of the participant",
"definition" : "The display name of the participant.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}]
},
{
"id" : "TestReport.setup",
"path" : "TestReport.setup",
"short" : "The results of the series of required setup operations before the tests were executed",
"definition" : "The results of the series of required setup operations before the tests were executed.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "TestReport.setup.action",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "SetupAction"
}],
"path" : "TestReport.setup.action",
"short" : "A setup operation or assert that was executed",
"definition" : "Action would contain either an operation or an assertion.",
"comment" : "An action should contain either an operation or an assertion but not both. It can contain any number of variables.",
"min" : 1,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "inv-1",
"severity" : "error",
"human" : "Setup action SHALL contain either an operation or assert but not both.",
"expression" : "operation.exists() xor assert.exists()",
"xpath" : "(f:operation or f:assert) and not(f:operation and f:assert)"
}]
},
{
"id" : "TestReport.setup.action.operation",
"path" : "TestReport.setup.action.operation",
"short" : "The operation to perform",
"definition" : "The operation performed.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "TestReport.setup.action.operation.result",
"path" : "TestReport.setup.action.operation.result",
"short" : "pass | skip | fail | warning | error",
"definition" : "The result of this operation.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "TestReportActionResult"
}],
"strength" : "required",
"description" : "The results of executing an action.",
"valueSet" : "http://hl7.org/fhir/ValueSet/report-action-result-codes|4.0.1"
}
},
{
"id" : "TestReport.setup.action.operation.message",
"path" : "TestReport.setup.action.operation.message",
"short" : "A message associated with the result",
"definition" : "An explanatory message associated with the result.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "markdown"
}]
},
{
"id" : "TestReport.setup.action.operation.detail",
"path" : "TestReport.setup.action.operation.detail",
"short" : "A link to further details on the result",
"definition" : "A link to further details on the result.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "uri"
}]
},
{
"id" : "TestReport.setup.action.assert",
"path" : "TestReport.setup.action.assert",
"short" : "The assertion to perform",
"definition" : "The results of the assertion performed on the previous operations.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "TestReport.setup.action.assert.result",
"path" : "TestReport.setup.action.assert.result",
"short" : "pass | skip | fail | warning | error",
"definition" : "The result of this assertion.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "TestReportActionResult"
}],
"strength" : "required",
"description" : "The results of executing an action.",
"valueSet" : "http://hl7.org/fhir/ValueSet/report-action-result-codes|4.0.1"
}
},
{
"id" : "TestReport.setup.action.assert.message",
"path" : "TestReport.setup.action.assert.message",
"short" : "A message associated with the result",
"definition" : "An explanatory message associated with the result.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "markdown"
}]
},
{
"id" : "TestReport.setup.action.assert.detail",
"path" : "TestReport.setup.action.assert.detail",
"short" : "A link to further details on the result",
"definition" : "A link to further details on the result.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}]
},
{
"id" : "TestReport.test",
"path" : "TestReport.test",
"short" : "A test executed from the test script",
"definition" : "A test executed from the test script.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "TestReport.test.name",
"path" : "TestReport.test.name",
"short" : "Tracking/logging name of this test",
"definition" : "The name of this test used for tracking/logging purposes by test engines.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}]
},
{
"id" : "TestReport.test.description",
"path" : "TestReport.test.description",
"short" : "Tracking/reporting short description of the test",
"definition" : "A short description of the test used by test engines for tracking and reporting purposes.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}]
},
{
"id" : "TestReport.test.action",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "TestAction"
}],
"path" : "TestReport.test.action",
"short" : "A test operation or assert that was performed",
"definition" : "Action would contain either an operation or an assertion.",
"comment" : "An action should contain either an operation or an assertion but not both. It can contain any number of variables.",
"min" : 1,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "inv-2",
"severity" : "error",
"human" : "Test action SHALL contain either an operation or assert but not both.",
"expression" : "operation.exists() xor assert.exists()",
"xpath" : "(f:operation or f:assert) and not(f:operation and f:assert)"
}]
},
{
"id" : "TestReport.test.action.operation",
"path" : "TestReport.test.action.operation",
"short" : "The operation performed",
"definition" : "An operation would involve a REST request to a server.",
"min" : 0,
"max" : "1",
"contentReference" : "#TestReport.setup.action.operation"
},
{
"id" : "TestReport.test.action.assert",
"path" : "TestReport.test.action.assert",
"short" : "The assertion performed",
"definition" : "The results of the assertion performed on the previous operations.",
"min" : 0,
"max" : "1",
"contentReference" : "#TestReport.setup.action.assert"
},
{
"id" : "TestReport.teardown",
"path" : "TestReport.teardown",
"short" : "The results of running the series of required clean up steps",
"definition" : "The results of the series of operations required to clean up after all the tests were executed (successfully or otherwise).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "TestReport.teardown.action",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "TeardownAction"
}],
"path" : "TestReport.teardown.action",
"short" : "One or more teardown operations performed",
"definition" : "The teardown action will only contain an operation.",
"comment" : "An action should contain either an operation or an assertion but not both. It can contain any number of variables.",
"min" : 1,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "TestReport.teardown.action.operation",
"path" : "TestReport.teardown.action.operation",
"short" : "The teardown operation performed",
"definition" : "An operation would involve a REST request to a server.",
"min" : 1,
"max" : "1",
"contentReference" : "#TestReport.setup.action.operation"
}]
}
}
},
{
"fullUrl" : "http://hl7.org/fhir/StructureDefinition/TestScript",
"resource" : {
"resourceType" : "StructureDefinition",
"id" : "TestScript",
"meta" : {
"lastUpdated" : "2019-11-01T09:29:23.356+11:00"
},
"text" : {
"status" : "generated",
"div" : "Name Flags Card. Type Description & Constraints TestScript ITU 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 url Σ 1..1 uri Canonical identifier for this test script, represented as a URI (globally unique) identifier Σ 0..1 Identifier Additional identifier for the test script version Σ 0..1 string Business version of the test script name ΣI 1..1 string Name for this test script (computer friendly) title Σ 0..1 string Name for this test script (human friendly) status ?!Σ 1..1 code draft | active | retired | unknown
PublicationStatus (Required) experimental Σ 0..1 boolean For testing purposes, not real usage date Σ 0..1 dateTime Date last changed publisher Σ 0..1 string Name of the publisher (organization or individual) contact Σ 0..* ContactDetail Contact details for the publisher
description 0..1 markdown Natural language description of the test script useContext Σ 0..* UsageContext The context that the content is intended to support
jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for test script (if applicable)
Jurisdiction (Extensible)
purpose 0..1 markdown Why this test script is defined copyright 0..1 markdown Use and/or publishing restrictions origin 0..* BackboneElement An abstract server representing a client or sender in a message exchange
index 1..1 integer The index of the abstract origin server starting at 1 profile 1..1 Coding FHIR-Client | FHIR-SDC-FormFiller
Test script profile origin type (Extensible) destination 0..* BackboneElement An abstract server representing a destination or receiver in a message exchange
index 1..1 integer The index of the abstract destination server starting at 1 profile 1..1 Coding FHIR-Server | FHIR-SDC-FormManager | FHIR-SDC-FormReceiver | FHIR-SDC-FormProcessor
Test script profile destination type (Extensible) metadata I 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. link 0..* BackboneElement Links to the FHIR specification
url 1..1 uri URL to the specification description 0..1 string Short description capability 1..* BackboneElement Capabilities that are assumed to function correctly on the FHIR server being tested
required 1..1 boolean Are the capabilities required? validated 1..1 boolean Are the capabilities validated? description 0..1 string The expected capabilities of the server origin 0..* integer Which origin server these requirements apply to
destination 0..1 integer Which server these requirements apply to link 0..* uri Links to the FHIR specification
capabilities 1..1 canonical(CapabilityStatement) Required Capability Statement fixture 0..* BackboneElement Fixture in the test script - by reference (uri)
autocreate 1..1 boolean Whether or not to implicitly create the fixture during setup autodelete 1..1 boolean Whether or not to implicitly delete the fixture during teardown resource 0..1 Reference(Any) Reference of the resource profile 0..* Reference(Any) Reference of the validation profile
variable I 0..* BackboneElement Placeholder for evaluated elements
+ Rule: Variable can only contain one of expression, headerField or path.
name 1..1 string Descriptive name for this variable defaultValue 0..1 string Default, hard-coded, or user-defined value for this variable description 0..1 string Natural language description of the variable expression 0..1 string The FHIRPath expression against the fixture body headerField 0..1 string HTTP header field name for source hint 0..1 string Hint help text for default value to enter path 0..1 string XPath or JSONPath against the fixture body sourceId 0..1 id Fixture Id of source expression or headerField within this variable setup 0..1 BackboneElement A series of required setup operations before tests are executed action I 1..* BackboneElement A setup operation or assert to perform
+ Rule: Setup action SHALL contain either an operation or assert but not both.
operation I 0..1 BackboneElement The setup operation to perform
+ Rule: Setup operation SHALL contain either sourceId or targetId or params or url. type 0..1 Coding The operation code type that will be executed
Test script operation code (Extensible) resource 0..1 code Resource type
FHIRDefinedType (Required) label 0..1 string Tracking/logging operation label description 0..1 string Tracking/reporting operation description accept 0..1 code Mime type to accept in the payload of the response, with charset etc.
MimeType (Required) contentType 0..1 code Mime type of the request payload contents, with charset etc.
MimeType (Required) destination 0..1 integer Server responding to the request encodeRequestUrl 1..1 boolean Whether or not to send the request url in encoded format method 0..1 code delete | get | options | patch | post | put | head
TestScriptRequestMethodCode (Required) origin 0..1 integer Server initiating the request params 0..1 string Explicitly defined path parameters requestHeader 0..* BackboneElement Each operation can have one or more header elements
field 1..1 string HTTP header field name value 1..1 string HTTP headerfield value requestId 0..1 id Fixture Id of mapped request responseId 0..1 id Fixture Id of mapped response sourceId 0..1 id Fixture Id of body for PUT and POST requests targetId 0..1 id Id of fixture used for extracting the [id], [type], and [vid] for GET requests url 0..1 string Request URL assert I 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 label 0..1 string Tracking/logging assertion label description 0..1 string Tracking/reporting assertion description direction 0..1 code response | request
AssertionDirectionType (Required) compareToSourceId 0..1 string Id of the source fixture to be evaluated compareToSourceExpression 0..1 string The FHIRPath expression to evaluate against the source fixture compareToSourcePath 0..1 string XPath or JSONPath expression to evaluate against the source fixture contentType 0..1 code Mime type to compare against the 'Content-Type' header
MimeType (Required) expression 0..1 string The FHIRPath expression to be evaluated headerField 0..1 string HTTP header field name minimumId 0..1 string Fixture Id of minimum content resource navigationLinks 0..1 boolean Perform validation on navigation links? operator 0..1 code equals | notEquals | in | notIn | greaterThan | lessThan | empty | notEmpty | contains | notContains | eval
AssertionOperatorType (Required) path 0..1 string XPath or JSONPath expression requestMethod 0..1 code delete | get | options | patch | post | put | head
TestScriptRequestMethodCode (Required) requestURL 0..1 string Request URL comparison value resource 0..1 code Resource type
FHIRDefinedType (Required) response 0..1 code okay | created | noContent | notModified | bad | forbidden | notFound | methodNotAllowed | conflict | gone | preconditionFailed | unprocessable
AssertionResponseTypes (Required) responseCode 0..1 string HTTP response code to test sourceId 0..1 id Fixture Id of source expression or headerField validateProfileId 0..1 id Profile Id of validation profile reference value 0..1 string The value to compare to warningOnly 1..1 boolean Will this assert produce a warning only on error? test 0..* BackboneElement A test in this script
name 0..1 string Tracking/logging name of this test description 0..1 string Tracking/reporting short description of the test action I 1..* BackboneElement A test operation or assert to perform
+ Rule: Test action SHALL contain either an operation or assert but not both.
operation I 0..1 see operation The setup operation to perform
+ Rule: Test operation SHALL contain either sourceId or targetId or params or url. assert I 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 teardown 0..1 BackboneElement A series of required clean up steps action 1..* BackboneElement One or more teardown operations to perform
operation I 1..1 see operation The teardown operation to perform
+ Rule: Teardown operation SHALL contain either sourceId or targetId or params or url.
Documentation for this format
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Specialized.Quality Reporting & Testing"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 2
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "anonymous"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "fhir"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/TestScript",
"version" : "4.0.1",
"name" : "TestScript",
"status" : "draft",
"date" : "2019-11-01T09:29:23+11:00",
"publisher" : "Health Level Seven International (FHIR Infrastructure)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/fiwg/index.cfm"
}]
}],
"description" : "A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.",
"fhirVersion" : "4.0.1",
"mapping" : [{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
},
{
"identity" : "workflow",
"uri" : "http://hl7.org/fhir/workflow",
"name" : "Workflow Pattern"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/fivews",
"name" : "FiveWs Pattern Mapping"
},
{
"identity" : "objimpl",
"uri" : "http://hl7.org/fhir/object-implementation",
"name" : "Object Implementation Information"
}],
"kind" : "resource",
"abstract" : false,
"type" : "TestScript",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"_baseDefinition" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-codegen-super",
"valueString" : "MetadataResource"
}]
},
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "TestScript",
"path" : "TestScript",
"short" : "Describes a set of tests",
"definition" : "A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "TestScript",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "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",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.`div`.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "tst-0",
"severity" : "warning",
"human" : "Name should be usable as an identifier for the module by machine processing applications such as code generation",
"expression" : "name.matches('[A-Z]([A-Za-z0-9_]){0,254}')",
"xpath" : "not(exists(f:name/@value)) or matches(f:name/@value, '[A-Z]([A-Za-z0-9_]){0,254}')"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "TestScript.id",
"path" : "TestScript.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "TestScript.meta",
"path" : "TestScript.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "TestScript.implicitRules",
"path" : "TestScript.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "TestScript.language",
"path" : "TestScript.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "TestScript.text",
"path" : "TestScript.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "TestScript.contained",
"path" : "TestScript.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "TestScript.extension",
"path" : "TestScript.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "TestScript.modifierExtension",
"path" : "TestScript.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "TestScript.url",
"path" : "TestScript.url",
"short" : "Canonical identifier for this test script, represented as a URI (globally unique)",
"definition" : "An absolute URI that is used to identify this test script when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this test script is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the test script is stored on different servers.",
"comment" : "Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.\n\nThe determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions). \n\nIn some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.",
"requirements" : "Allows the test script to be referenced by a single globally unique identifier.",
"alias" : ["url",
"authoritative-url",
"destination",
"identity"],
"min" : 1,
"max" : "1",
"base" : {
"path" : "TestScript.url",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.url"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
}]
},
{
"id" : "TestScript.identifier",
"path" : "TestScript.identifier",
"short" : "Additional identifier for the test script",
"definition" : "A formal identifier that is used to identify this test script when it is represented in other formats, or referenced in a specification, model, design or an instance.",
"comment" : "Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this test script outside of FHIR, where it is not possible to use the logical URI.",
"requirements" : "Allows externally provided and/or usable business identifiers to be easily associated with the module.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TestScript.identifier",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Identifier"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.identifier"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "TestScript.version",
"path" : "TestScript.version",
"short" : "Business version of the test script",
"definition" : "The identifier that is used to identify this version of the test script when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the test script author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.",
"comment" : "There may be different test script instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the test script with the format [url]|[version].",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TestScript.version",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.version"
},
{
"identity" : "w5",
"map" : "FiveWs.version"
}]
},
{
"id" : "TestScript.name",
"path" : "TestScript.name",
"short" : "Name for this test script (computer friendly)",
"definition" : "A natural language name identifying the test script. This name should be usable as an identifier for the module by machine processing applications such as code generation.",
"comment" : "The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.",
"requirements" : "Support human navigation and code generation.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "TestScript.name",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"condition" : ["inv-0"],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "TestScript.title",
"path" : "TestScript.title",
"short" : "Name for this test script (human friendly)",
"definition" : "A short, descriptive, user-friendly title for the test script.",
"comment" : "This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TestScript.title",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.title"
}]
},
{
"id" : "TestScript.status",
"path" : "TestScript.status",
"short" : "draft | active | retired | unknown",
"definition" : "The status of this test script. Enables tracking the life-cycle of the content.",
"comment" : "Allows filtering of test scripts that are appropriate for use versus not.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "TestScript.status",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This is labeled as \"Is Modifier\" because applications should not use a retired {{title}} without due consideration",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "PublicationStatus"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "The lifecycle status of an artifact.",
"valueSet" : "http://hl7.org/fhir/ValueSet/publication-status|4.0.1"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.status"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
}]
},
{
"id" : "TestScript.experimental",
"path" : "TestScript.experimental",
"short" : "For testing purposes, not real usage",
"definition" : "A Boolean value to indicate that this test script is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.",
"comment" : "Allows filtering of test scripts that are appropriate for use versus not.",
"requirements" : "Enables experimental content to be developed following the same lifecycle that would be used for a production-level test script.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TestScript.experimental",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.experimental"
},
{
"identity" : "w5",
"map" : "FiveWs.class"
}]
},
{
"id" : "TestScript.date",
"path" : "TestScript.date",
"short" : "Date last changed",
"definition" : "The date (and optionally time) when the test script was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the test script changes.",
"comment" : "Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the test script. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.",
"alias" : ["Revision Date"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "TestScript.date",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.date"
},
{
"identity" : "w5",
"map" : "FiveWs.recorded"
}]
},
{
"id" : "TestScript.publisher",
"path" : "TestScript.publisher",
"short" : "Name of the publisher (organization or individual)",
"definition" : "The name of the organization or individual that published the test script.",
"comment" : "Usually an organization but may be an individual. The publisher (or steward) of the test script is the organization or individual primarily responsible for the maintenance and upkeep of the test script. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the test script. This item SHOULD be populated unless the information is available from context.",
"requirements" : "Helps establish the \"authority/credibility\" of the test script. May also allow for contact.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TestScript.publisher",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.publisher"
},
{
"identity" : "w5",
"map" : "FiveWs.witness"
}]
},
{
"id" : "TestScript.contact",
"path" : "TestScript.contact",
"short" : "Contact details for the publisher",
"definition" : "Contact details to assist a user in finding and communicating with the publisher.",
"comment" : "May be a web site, an email address, a telephone number, etc.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "TestScript.contact",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "ContactDetail"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.contact"
}]
},
{
"id" : "TestScript.description",
"path" : "TestScript.description",
"short" : "Natural language description of the test script",
"definition" : "A free text natural language description of the test script from a consumer's perspective.",
"comment" : "This description can be used to capture details such as why the test script was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the test script as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the test script is presumed to be the predominant language in the place the test script was created).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TestScript.description",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "markdown"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.description"
}]
},
{
"id" : "TestScript.useContext",
"path" : "TestScript.useContext",
"short" : "The context that the content is intended to support",
"definition" : "The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate test script instances.",
"comment" : "When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.",
"requirements" : "Assist in searching for appropriate content.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "TestScript.useContext",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "UsageContext"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.useContext"
}]
},
{
"id" : "TestScript.jurisdiction",
"path" : "TestScript.jurisdiction",
"short" : "Intended jurisdiction for test script (if applicable)",
"definition" : "A legal or geographic region in which the test script is intended to be used.",
"comment" : "It may be possible for the test script to be used in jurisdictions other than those for which it was originally designed or intended.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "TestScript.jurisdiction",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Jurisdiction"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "extensible",
"description" : "Countries and regions within which this artifact is targeted for use.",
"valueSet" : "http://hl7.org/fhir/ValueSet/jurisdiction"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.jurisdiction"
}]
},
{
"id" : "TestScript.purpose",
"path" : "TestScript.purpose",
"short" : "Why this test script is defined",
"definition" : "Explanation of why this test script is needed and why it has been designed as it has.",
"comment" : "This element does not describe the usage of the test script. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this test script.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TestScript.purpose",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "markdown"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.purpose"
},
{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "TestScript.copyright",
"path" : "TestScript.copyright",
"short" : "Use and/or publishing restrictions",
"definition" : "A copyright statement relating to the test script and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the test script.",
"requirements" : "Consumers must be able to determine any legal restrictions on the use of the test script and/or its content.",
"alias" : ["License",
"Restrictions"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "TestScript.copyright",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "markdown"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.copyright"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "TestScript.origin",
"path" : "TestScript.origin",
"short" : "An abstract server representing a client or sender in a message exchange",
"definition" : "An abstract server used in operations within this test script in the origin element.",
"comment" : "The purpose of this element is to define the profile of an origin element used elsewhere in the script. Test engines could then use the origin-profile mapping to offer a filtered list of test systems that can serve as the sender for the interaction.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "TestScript.origin",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TestScript.origin.id",
"path" : "TestScript.origin.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "TestScript.origin.extension",
"path" : "TestScript.origin.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "TestScript.origin.modifierExtension",
"path" : "TestScript.origin.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "TestScript.origin.index",
"path" : "TestScript.origin.index",
"short" : "The index of the abstract origin server starting at 1",
"definition" : "Abstract name given to an origin server in this test script. The name is provided as a number starting at 1.",
"comment" : "A given origin index (e.g. 1) can appear only once in the list (e.g. Origin 1 cannot be specified twice ... once as FormFiller and again as FormProcessor within the same script as that could get confusing during test configuration). \n\nDifferent origin indices could play the same actor in the same test script (e.g. You could have two different test systems acting as Form-Filler).\n\nThe origin indices provided elsewhere in the test script must be one of these origin indices.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "TestScript.origin.index",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "integer"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TestScript.origin.profile",
"path" : "TestScript.origin.profile",
"short" : "FHIR-Client | FHIR-SDC-FormFiller",
"definition" : "The type of origin profile the test system supports.",
"comment" : "Must be a \"sender\"/\"client\" profile.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "TestScript.origin.profile",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "Coding"
}],
"meaningWhenMissing" : "FHIR-Client",
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "TestScriptProfileOriginType"
}],
"strength" : "extensible",
"description" : "The type of origin profile the test system supports.",
"valueSet" : "http://hl7.org/fhir/ValueSet/testscript-profile-origin-types"
}
},
{
"id" : "TestScript.destination",
"path" : "TestScript.destination",
"short" : "An abstract server representing a destination or receiver in a message exchange",
"definition" : "An abstract server used in operations within this test script in the destination element.",
"comment" : "The purpose of this element is to define the profile of a destination element used elsewhere in the script. Test engines could then use the destination-profile mapping to offer a filtered list of test systems that can serve as the receiver for the interaction.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "TestScript.destination",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TestScript.destination.id",
"path" : "TestScript.destination.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "TestScript.destination.extension",
"path" : "TestScript.destination.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "TestScript.destination.modifierExtension",
"path" : "TestScript.destination.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "TestScript.destination.index",
"path" : "TestScript.destination.index",
"short" : "The index of the abstract destination server starting at 1",
"definition" : "Abstract name given to a destination server in this test script. The name is provided as a number starting at 1.",
"comment" : "A given destination index (e.g. 1) can appear only once in the list (e.g. Destination 1 cannot be specified twice ... once as Form-Manager and again as Form-Processor within the same script as that could get confusing during test configuration). \n\nDifferent destination indices could play the same actor in the same test script (e.g. You could have two different test systems acting as Form-Manager).\n\nThe destination indices provided elsewhere in the test script must be one of these destination indices.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "TestScript.destination.index",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "integer"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TestScript.destination.profile",
"path" : "TestScript.destination.profile",
"short" : "FHIR-Server | FHIR-SDC-FormManager | FHIR-SDC-FormReceiver | FHIR-SDC-FormProcessor",
"definition" : "The type of destination profile the test system supports.",
"comment" : "Must be a \"receiver\"/\"server\" profile.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "TestScript.destination.profile",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "Coding"
}],
"meaningWhenMissing" : "FHIR-Server",
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "TestScriptProfileDestinationType"
}],
"strength" : "extensible",
"description" : "The type of destination profile the test system supports.",
"valueSet" : "http://hl7.org/fhir/ValueSet/testscript-profile-destination-types"
}
},
{
"id" : "TestScript.metadata",
"path" : "TestScript.metadata",
"short" : "Required capability that is assumed to function correctly on the FHIR server being tested",
"definition" : "The required capability must exist and are assumed to function correctly on the FHIR server being tested.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TestScript.metadata",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "tst-4",
"severity" : "error",
"human" : "TestScript metadata capability SHALL contain required or validated or both.",
"expression" : "capability.required.exists() or capability.validated.exists()",
"xpath" : "f:capability/f:required or f:capability/f:validated or (f:capability/f:required and f:capability/f:validated)"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TestScript.metadata.id",
"path" : "TestScript.metadata.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "TestScript.metadata.extension",
"path" : "TestScript.metadata.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "TestScript.metadata.modifierExtension",
"path" : "TestScript.metadata.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "TestScript.metadata.link",
"path" : "TestScript.metadata.link",
"short" : "Links to the FHIR specification",
"definition" : "A link to the FHIR specification that this test is covering.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "TestScript.metadata.link",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TestScript.metadata.link.id",
"path" : "TestScript.metadata.link.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "TestScript.metadata.link.extension",
"path" : "TestScript.metadata.link.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "TestScript.metadata.link.modifierExtension",
"path" : "TestScript.metadata.link.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "TestScript.metadata.link.url",
"path" : "TestScript.metadata.link.url",
"short" : "URL to the specification",
"definition" : "URL to a particular requirement or feature within the FHIR specification.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "TestScript.metadata.link.url",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TestScript.metadata.link.description",
"path" : "TestScript.metadata.link.description",
"short" : "Short description",
"definition" : "Short description of the link.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TestScript.metadata.link.description",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TestScript.metadata.capability",
"path" : "TestScript.metadata.capability",
"short" : "Capabilities that are assumed to function correctly on the FHIR server being tested",
"definition" : "Capabilities that must exist and are assumed to function correctly on the FHIR server being tested.",
"comment" : "When the metadata capabilities section is defined at TestScript.metadata or at TestScript.setup.metadata, and the server's conformance statement does not contain the elements defined in the minimal conformance statement, then all the tests in the TestScript are skipped. When the metadata capabilities section is defined at TestScript.test.metadata and the server's conformance statement does not contain the elements defined in the minimal conformance statement, then only that test is skipped. The \"metadata.capabilities.required\" and \"metadata.capabilities.validated\" elements only indicate whether the capabilities are the primary focus of the test script or not. They do not impact the skipping logic. Capabilities whose \"metadata.capabilities.validated\" flag is true are the primary focus of the test script.",
"min" : 1,
"max" : "*",
"base" : {
"path" : "TestScript.metadata.capability",
"min" : 1,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TestScript.metadata.capability.id",
"path" : "TestScript.metadata.capability.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "TestScript.metadata.capability.extension",
"path" : "TestScript.metadata.capability.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "TestScript.metadata.capability.modifierExtension",
"path" : "TestScript.metadata.capability.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "TestScript.metadata.capability.required",
"path" : "TestScript.metadata.capability.required",
"short" : "Are the capabilities required?",
"definition" : "Whether or not the test execution will require the given capabilities of the server in order for this test script to execute.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "TestScript.metadata.capability.required",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TestScript.metadata.capability.validated",
"path" : "TestScript.metadata.capability.validated",
"short" : "Are the capabilities validated?",
"definition" : "Whether or not the test execution will validate the given capabilities of the server in order for this test script to execute.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "TestScript.metadata.capability.validated",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TestScript.metadata.capability.description",
"path" : "TestScript.metadata.capability.description",
"short" : "The expected capabilities of the server",
"definition" : "Description of the capabilities that this test script is requiring the server to support.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TestScript.metadata.capability.description",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TestScript.metadata.capability.origin",
"path" : "TestScript.metadata.capability.origin",
"short" : "Which origin server these requirements apply to",
"definition" : "Which origin server these requirements apply to.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "TestScript.metadata.capability.origin",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "integer"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TestScript.metadata.capability.destination",
"path" : "TestScript.metadata.capability.destination",
"short" : "Which server these requirements apply to",
"definition" : "Which server these requirements apply to.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TestScript.metadata.capability.destination",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "integer"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TestScript.metadata.capability.link",
"path" : "TestScript.metadata.capability.link",
"short" : "Links to the FHIR specification",
"definition" : "Links to the FHIR specification that describes this interaction and the resources involved in more detail.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "TestScript.metadata.capability.link",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TestScript.metadata.capability.capabilities",
"path" : "TestScript.metadata.capability.capabilities",
"short" : "Required Capability Statement",
"definition" : "Minimum capabilities required of server for test script to execute successfully. If server does not meet at a minimum the referenced capability statement, then all tests in this script are skipped.",
"comment" : "The conformance statement of the server has to contain at a minimum the contents of the reference pointed to by this element.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "TestScript.metadata.capability.capabilities",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/CapabilityStatement"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TestScript.fixture",
"path" : "TestScript.fixture",
"short" : "Fixture in the test script - by reference (uri)",
"definition" : "Fixture in the test script - by reference (uri). All fixtures are required for the test script to execute.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "TestScript.fixture",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TestScript.fixture.id",
"path" : "TestScript.fixture.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "TestScript.fixture.extension",
"path" : "TestScript.fixture.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "TestScript.fixture.modifierExtension",
"path" : "TestScript.fixture.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "TestScript.fixture.autocreate",
"path" : "TestScript.fixture.autocreate",
"short" : "Whether or not to implicitly create the fixture during setup",
"definition" : "Whether or not to implicitly create the fixture during setup. If true, the fixture is automatically created on each server being tested during setup, therefore no create operation is required for this fixture in the TestScript.setup section.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "TestScript.fixture.autocreate",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TestScript.fixture.autodelete",
"path" : "TestScript.fixture.autodelete",
"short" : "Whether or not to implicitly delete the fixture during teardown",
"definition" : "Whether or not to implicitly delete the fixture during teardown. If true, the fixture is automatically deleted on each server being tested during teardown, therefore no delete operation is required for this fixture in the TestScript.teardown section.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "TestScript.fixture.autodelete",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TestScript.fixture.resource",
"path" : "TestScript.fixture.resource",
"short" : "Reference of the resource",
"definition" : "Reference to the resource (containing the contents of the resource needed for operations).",
"comment" : "See http://build.fhir.org/resourcelist.html for complete list of resource types.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TestScript.fixture.resource",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TestScript.profile",
"path" : "TestScript.profile",
"short" : "Reference of the validation profile",
"definition" : "Reference to the profile to be used for validation.",
"comment" : "See http://build.fhir.org/resourcelist.html for complete list of resource types.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "TestScript.profile",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TestScript.variable",
"path" : "TestScript.variable",
"short" : "Placeholder for evaluated elements",
"definition" : "Variable is set based either on element value in response body or on header field value in the response headers.",
"comment" : "Variables would be set based either on XPath/JSONPath expressions against fixtures (static and response), or headerField evaluations against response headers. If variable evaluates to nodelist or anything other than a primitive value, then test engine would report an error. Variables would be used to perform clean replacements in \"operation.params\", \"operation.requestHeader.value\", and \"operation.url\" element values during operation calls and in \"assert.value\" during assertion evaluations. This limits the places that test engines would need to look for placeholders \"${}\". Variables are scoped to the whole script. They are NOT evaluated at declaration. They are evaluated by test engine when used for substitutions in \"operation.params\", \"operation.requestHeader.value\", and \"operation.url\" element values during operation calls and in \"assert.value\" during assertion evaluations. See example testscript-search.xml.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "TestScript.variable",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "tst-3",
"severity" : "error",
"human" : "Variable can only contain one of expression, headerField or path.",
"expression" : "expression.empty() or headerField.empty() or path.empty()",
"xpath" : "not(f:expression and f:headerField and f:path)"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TestScript.variable.id",
"path" : "TestScript.variable.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "TestScript.variable.extension",
"path" : "TestScript.variable.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "TestScript.variable.modifierExtension",
"path" : "TestScript.variable.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "TestScript.variable.name",
"path" : "TestScript.variable.name",
"short" : "Descriptive name for this variable",
"definition" : "Descriptive name for this variable.",
"comment" : "Placeholders would contain the variable name wrapped in ${} in \"operation.params\", \"operation.requestHeader.value\", and \"operation.url\" elements. These placeholders would need to be replaced by the variable value before the operation is executed.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "TestScript.variable.name",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TestScript.variable.defaultValue",
"path" : "TestScript.variable.defaultValue",
"short" : "Default, hard-coded, or user-defined value for this variable",
"definition" : "A default, hard-coded, or user-defined value for this variable.",
"comment" : "The purpose of this element is to allow for a pre-defined value that can be used as a default or as an override value. Test engines can optionally use this as a placeholder for user-defined execution time values.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TestScript.variable.defaultValue",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TestScript.variable.description",
"path" : "TestScript.variable.description",
"short" : "Natural language description of the variable",
"definition" : "A free text natural language description of the variable and its purpose.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TestScript.variable.description",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TestScript.variable.expression",
"path" : "TestScript.variable.expression",
"short" : "The FHIRPath expression against the fixture body",
"definition" : "The FHIRPath expression to evaluate against the fixture body. When variables are defined, only one of either expression, headerField or path must be specified.",
"comment" : "If headerField is defined, then the variable will be evaluated against the headers that sourceId is pointing to. If expression or path is defined, then the variable will be evaluated against the fixture body that sourceId is pointing to. It is an error to define any combination of expression, headerField and path.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TestScript.variable.expression",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TestScript.variable.headerField",
"path" : "TestScript.variable.headerField",
"short" : "HTTP header field name for source",
"definition" : "Will be used to grab the HTTP header field value from the headers that sourceId is pointing to.",
"comment" : "If headerField is defined, then the variable will be evaluated against the headers that sourceId is pointing to. If path is defined, then the variable will be evaluated against the fixture body that sourceId is pointing to. It is an error to define both headerField and path.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TestScript.variable.headerField",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TestScript.variable.hint",
"path" : "TestScript.variable.hint",
"short" : "Hint help text for default value to enter",
"definition" : "Displayable text string with hint help information to the user when entering a default value.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TestScript.variable.hint",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TestScript.variable.path",
"path" : "TestScript.variable.path",
"short" : "XPath or JSONPath against the fixture body",
"definition" : "XPath or JSONPath to evaluate against the fixture body. When variables are defined, only one of either expression, headerField or path must be specified.",
"comment" : "If headerField is defined, then the variable will be evaluated against the headers that sourceId is pointing to. If expression or path is defined, then the variable will be evaluated against the fixture body that sourceId is pointing to. It is an error to define any combination of expression, headerField and path.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TestScript.variable.path",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TestScript.variable.sourceId",
"path" : "TestScript.variable.sourceId",
"short" : "Fixture Id of source expression or headerField within this variable",
"definition" : "Fixture to evaluate the XPath/JSONPath expression or the headerField against within this variable.",
"comment" : "This can be a statically defined fixture (at the top of the TestScript) or a dynamically set fixture created by responseId of the `action.operation` element.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TestScript.variable.sourceId",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "id"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TestScript.setup",
"path" : "TestScript.setup",
"short" : "A series of required setup operations before tests are executed",
"definition" : "A series of required setup operations before tests are executed.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TestScript.setup",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TestScript.setup.id",
"path" : "TestScript.setup.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "TestScript.setup.extension",
"path" : "TestScript.setup.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "TestScript.setup.modifierExtension",
"path" : "TestScript.setup.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "TestScript.setup.action",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "SetupAction"
}],
"path" : "TestScript.setup.action",
"short" : "A setup operation or assert to perform",
"definition" : "Action would contain either an operation or an assertion.",
"comment" : "An action should contain either an operation or an assertion but not both. It can contain any number of variables.",
"min" : 1,
"max" : "*",
"base" : {
"path" : "TestScript.setup.action",
"min" : 1,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "tst-1",
"severity" : "error",
"human" : "Setup action SHALL contain either an operation or assert but not both.",
"expression" : "operation.exists() xor assert.exists()",
"xpath" : "(f:operation or f:assert) and not(f:operation and f:assert)"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TestScript.setup.action.id",
"path" : "TestScript.setup.action.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "TestScript.setup.action.extension",
"path" : "TestScript.setup.action.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "TestScript.setup.action.modifierExtension",
"path" : "TestScript.setup.action.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "TestScript.setup.action.operation",
"path" : "TestScript.setup.action.operation",
"short" : "The setup operation to perform",
"definition" : "The operation to perform.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TestScript.setup.action.operation",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "tst-7",
"severity" : "error",
"human" : "Setup operation SHALL contain either sourceId or targetId or params or url.",
"expression" : "sourceId.exists() or (targetId.count() + url.count() + params.count() = 1) or (type.code in ('capabilities' |'search' | 'transaction' | 'history'))",
"xpath" : "f:sourceId or ((f:targetId or f:url or f:params) and (count(f:targetId) + count(f:url) + count(f:params) =1)) or (f:type/f:code/@value='capabilities' or f:type/f:code/@value='search' or f:type/f:code/@value='transaction' or f:type/f:code/@value='history')"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TestScript.setup.action.operation.id",
"path" : "TestScript.setup.action.operation.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "TestScript.setup.action.operation.extension",
"path" : "TestScript.setup.action.operation.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "TestScript.setup.action.operation.modifierExtension",
"path" : "TestScript.setup.action.operation.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "TestScript.setup.action.operation.type",
"path" : "TestScript.setup.action.operation.type",
"short" : "The operation code type that will be executed",
"definition" : "Server interaction or operation type.",
"comment" : "See http://build.fhir.org/http.html for list of server interactions.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TestScript.setup.action.operation.type",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Coding"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "TestScriptOperationCode"
}],
"strength" : "extensible",
"description" : "The allowable operation code types.",
"valueSet" : "http://hl7.org/fhir/ValueSet/testscript-operation-codes"
}
},
{
"id" : "TestScript.setup.action.operation.resource",
"path" : "TestScript.setup.action.operation.resource",
"short" : "Resource type",
"definition" : "The type of the resource. See http://build.fhir.org/resourcelist.html.",
"comment" : "If \"url\" element is specified, then \"targetId\", \"params\", and \"resource\" elements will be ignored as \"url\" element will have everything needed for constructing the request url. If \"params\" element is specified, then \"targetId\" element is ignored. For FHIR operations that require a resource (e.g. \"read\" and \"vread\" operations), the \"resource\" element must be specified when \"params\" element is specified. If \"url\" and \"params\" elements are absent, then the request url will be constructed from \"targetId\" fixture if present. For \"read\" operation, the resource and id values will be extracted from \"targetId\" fixture and used to construct the url. For \"vread\" and \"history\" operations, the versionId value will also be used.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TestScript.setup.action.operation.resource",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "FHIRDefinedType"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "A list of all the concrete types defined in this version of the FHIR specification - Data Types and Resource Types.",
"valueSet" : "http://hl7.org/fhir/ValueSet/defined-types|4.0.1"
}
},
{
"id" : "TestScript.setup.action.operation.label",
"path" : "TestScript.setup.action.operation.label",
"short" : "Tracking/logging operation label",
"definition" : "The label would be used for tracking/logging purposes by test engines.",
"comment" : "This has no impact on the verification itself.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TestScript.setup.action.operation.label",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TestScript.setup.action.operation.description",
"path" : "TestScript.setup.action.operation.description",
"short" : "Tracking/reporting operation description",
"definition" : "The description would be used by test engines for tracking and reporting purposes.",
"comment" : "This has no impact on the verification itself.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TestScript.setup.action.operation.description",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TestScript.setup.action.operation.accept",
"path" : "TestScript.setup.action.operation.accept",
"short" : "Mime type to accept in the payload of the response, with charset etc.",
"definition" : "The mime-type to use for RESTful operation in the 'Accept' header.",
"comment" : "If this is specified, then test engine shall set the 'Accept' header to the corresponding value. If you'd like to explicitly set the 'Accept' to some other value then use the 'requestHeader' element.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TestScript.setup.action.operation.accept",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"example" : [{
"label" : "General",
"valueCode" : "application/fhir+xml"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MimeType"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "The mime type of an attachment. Any valid mime type is allowed.",
"valueSet" : "http://hl7.org/fhir/ValueSet/mimetypes|4.0.1"
}
},
{
"id" : "TestScript.setup.action.operation.contentType",
"path" : "TestScript.setup.action.operation.contentType",
"short" : "Mime type of the request payload contents, with charset etc.",
"definition" : "The mime-type to use for RESTful operation in the 'Content-Type' header.",
"comment" : "If this is specified, then test engine shall set the 'Content-Type' header to the corresponding value. If you'd like to explicitly set the 'Content-Type' to some other value then use the 'requestHeader' element.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TestScript.setup.action.operation.contentType",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"example" : [{
"label" : "General",
"valueCode" : "application/fhir+xml"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MimeType"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "The mime type of an attachment. Any valid mime type is allowed.",
"valueSet" : "http://hl7.org/fhir/ValueSet/mimetypes|4.0.1"
}
},
{
"id" : "TestScript.setup.action.operation.destination",
"path" : "TestScript.setup.action.operation.destination",
"short" : "Server responding to the request",
"definition" : "The server where the request message is destined for. Must be one of the server numbers listed in TestScript.destination section.",
"comment" : "If multiple TestScript.destination elements are defined and operation.destination is undefined, test engine will report an error as it cannot determine what destination to use for the exchange.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TestScript.setup.action.operation.destination",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "integer"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TestScript.setup.action.operation.encodeRequestUrl",
"path" : "TestScript.setup.action.operation.encodeRequestUrl",
"short" : "Whether or not to send the request url in encoded format",
"definition" : "Whether or not to implicitly send the request url in encoded format. The default is true to match the standard RESTful client behavior. Set to false when communicating with a server that does not support encoded url paths.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "TestScript.setup.action.operation.encodeRequestUrl",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TestScript.setup.action.operation.method",
"path" : "TestScript.setup.action.operation.method",
"short" : "delete | get | options | patch | post | put | head",
"definition" : "The HTTP method the test engine MUST use for this operation regardless of any other operation details.",
"comment" : "The primary purpose of the explicit HTTP method is support of HTTP POST method invocation of the FHIR search. Other uses will include support of negative testing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TestScript.setup.action.operation.method",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "TestScriptRequestMethodCode"
}],
"strength" : "required",
"description" : "The allowable request method or HTTP operation codes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/http-operations|4.0.1"
}
},
{
"id" : "TestScript.setup.action.operation.origin",
"path" : "TestScript.setup.action.operation.origin",
"short" : "Server initiating the request",
"definition" : "The server where the request message originates from. Must be one of the server numbers listed in TestScript.origin section.",
"comment" : "If absent, test engine will send the message. When present, test engine will not send the request message but will wait for the request message to be sent from this origin server.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TestScript.setup.action.operation.origin",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "integer"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TestScript.setup.action.operation.params",
"path" : "TestScript.setup.action.operation.params",
"short" : "Explicitly defined path parameters",
"definition" : "Path plus parameters after [type]. Used to set parts of the request URL explicitly.",
"comment" : "If \"url\" element is specified, then \"targetId\", \"params\", and \"resource\" elements will be ignored as \"url\" element will have everything needed for constructing the request url. If \"params\" element is specified, then \"targetId\" element is ignored. For FHIR operations that require a resource (e.g. \"read\" and \"vread\" operations), the \"resource\" element must be specified when \"params\" element is specified. If \"url\" and \"params\" elements are absent, then the request url will be constructed from \"targetId\" fixture if present. For \"read\" operation, the resource and id values will be extracted from \"targetId\" fixture and used to construct the url. For \"vread\" and \"history\" operations, the versionId value will also be used. Test engines would append whatever is specified for \"params\" to the URL after the resource type without tampering with the string (beyond encoding the URL for HTTP). The \"params\" element does not correspond exactly to \"search parameters\". Nor is it the \"path\". It corresponds to the part of the URL that comes after the [type] (when \"resource\" element is specified); e.g. It corresponds to \"/[id]/_history/[vid] {?_format=[mime-type]}\" in the following operation: GET [base]/[type]/[id]/_history/[vid] {?_format=[mime-type]} Test engines do have to look for placeholders (${}) and replace the variable placeholders with the variable values at runtime before sending the request.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TestScript.setup.action.operation.params",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TestScript.setup.action.operation.requestHeader",
"path" : "TestScript.setup.action.operation.requestHeader",
"short" : "Each operation can have one or more header elements",
"definition" : "Header elements would be used to set HTTP headers.",
"comment" : "This gives control to test-script writers to set headers explicitly based on test requirements. It will allow for testing using: - \"If-Modified-Since\" and \"If-None-Match\" headers. See http://build.fhir.org/http.html#2.1.0.5.1 - \"If-Match\" header. See http://build.fhir.org/http.html#2.1.0.11 - Conditional Create using \"If-None-Exist\". See http://build.fhir.org/http.html#2.1.0.13.1 - Invalid \"Content-Type\" header for negative testing. - etc.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "TestScript.setup.action.operation.requestHeader",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TestScript.setup.action.operation.requestHeader.id",
"path" : "TestScript.setup.action.operation.requestHeader.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "TestScript.setup.action.operation.requestHeader.extension",
"path" : "TestScript.setup.action.operation.requestHeader.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "TestScript.setup.action.operation.requestHeader.modifierExtension",
"path" : "TestScript.setup.action.operation.requestHeader.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "TestScript.setup.action.operation.requestHeader.field",
"path" : "TestScript.setup.action.operation.requestHeader.field",
"short" : "HTTP header field name",
"definition" : "The HTTP header field e.g. \"Accept\".",
"comment" : "If header element is specified, then field is required.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "TestScript.setup.action.operation.requestHeader.field",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TestScript.setup.action.operation.requestHeader.value",
"path" : "TestScript.setup.action.operation.requestHeader.value",
"short" : "HTTP headerfield value",
"definition" : "The value of the header e.g. \"application/fhir+xml\".",
"comment" : "If header element is specified, then value is required. No conversions will be done by the test engine e.g. \"xml\" to \"application/fhir+xml\". The values will be set in HTTP headers \"as-is\". Test engines do have to look for placeholders (${}) and replace the variable placeholders with the variable values at runtime before sending the request.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "TestScript.setup.action.operation.requestHeader.value",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TestScript.setup.action.operation.requestId",
"path" : "TestScript.setup.action.operation.requestId",
"short" : "Fixture Id of mapped request",
"definition" : "The fixture id (maybe new) to map to the request.",
"comment" : "If a requestId is supplied, then the resulting request (both headers and body) is mapped to the fixture ID (which may be entirely new and previously undeclared) designated by \"requestId\". If requestId is not specified, it is the test engine's responsibility to store the request and use it as the requestId in subsequent assertions when assertion path and/or headerField is specified, direction is equal to request, and the requestId in not specified.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TestScript.setup.action.operation.requestId",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "id"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TestScript.setup.action.operation.responseId",
"path" : "TestScript.setup.action.operation.responseId",
"short" : "Fixture Id of mapped response",
"definition" : "The fixture id (maybe new) to map to the response.",
"comment" : "If a responseId is supplied, and the server responds, then the resulting response (both headers and body) is mapped to the fixture ID (which may be entirely new and previously undeclared) designated by \"responseId\". If responseId is not specified, it is the test engine's responsibility to store the response and use it as the responseId in subsequent assertions when assertion path and/or headerField is specified and the responseId is not specified.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TestScript.setup.action.operation.responseId",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "id"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TestScript.setup.action.operation.sourceId",
"path" : "TestScript.setup.action.operation.sourceId",
"short" : "Fixture Id of body for PUT and POST requests",
"definition" : "The id of the fixture used as the body of a PUT or POST request.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TestScript.setup.action.operation.sourceId",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "id"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TestScript.setup.action.operation.targetId",
"path" : "TestScript.setup.action.operation.targetId",
"short" : "Id of fixture used for extracting the [id], [type], and [vid] for GET requests",
"definition" : "Id of fixture used for extracting the [id], [type], and [vid] for GET requests.",
"comment" : "If \"url\" element is specified, then \"targetId\", \"params\", and \"resource\" elements will be ignored as \"url\" element will have everything needed for constructing the request url. If \"params\" element is specified, then \"targetId\" element is ignored. For FHIR operations that require a resource (e.g. \"read\" and \"vread\" operations), the \"resource\" element must be specified when \"params\" element is specified. If \"url\" and \"params\" elements are absent, then the request url will be constructed from \"targetId\" fixture if present. For \"read\" operation, the resource and id values will be extracted from \"targetId\" fixture and used to construct the url. For \"vread\" and \"history\" operations, the versionId value will also be used.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TestScript.setup.action.operation.targetId",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "id"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TestScript.setup.action.operation.url",
"path" : "TestScript.setup.action.operation.url",
"short" : "Request URL",
"definition" : "Complete request URL.",
"comment" : "Used to set the request URL explicitly. If \"url\" element is defined, then \"targetId\", \"resource\", and \"params\" elements will be ignored. Test engines would use whatever is specified in \"url\" without tampering with the string (beyond encoding the URL for HTTP). Test engines do have to look for placeholders (${}) and replace the variable placeholders with the variable values at runtime before sending the request.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TestScript.setup.action.operation.url",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TestScript.setup.action.assert",
"path" : "TestScript.setup.action.assert",
"short" : "The assertion to perform",
"definition" : "Evaluates the results of previous operations to determine if the server under test behaves appropriately.",
"comment" : "In order to evaluate an assertion, the request, response, and results of the most recently executed operation must always be maintained by the test engine.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TestScript.setup.action.assert",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "tst-5",
"severity" : "error",
"human" : "Only a single assertion SHALL be present within setup action assert element.",
"expression" : "extension.exists() or (contentType.count() + expression.count() + headerField.count() + minimumId.count() + navigationLinks.count() + path.count() + requestMethod.count() + resource.count() + responseCode.count() + response.count() + validateProfileId.count() <=1)",
"xpath" : "count(f:contentType) + count(f:expression) + count(f:headerField) + count(f:minimumId) + count(f:navigationLinks) + count(f:path) + count(f:requestMethod) + count(f:resource) + count(f:responseCode) + count(f:response) + count(f:rule) + count(f:ruleset) + count(f:validateProfileId) <=1"
},
{
"key" : "tst-10",
"severity" : "error",
"human" : "Setup action assert SHALL contain either compareToSourceId and compareToSourceExpression, compareToSourceId and compareToSourcePath or neither.",
"expression" : "compareToSourceId.empty() xor (compareToSourceExpression.exists() or compareToSourcePath.exists())",
"xpath" : "(f:compareToSourceId and f:compareToSourceExpression) or (f:compareToSourceId and f:compareToSourcePath) or not(f:compareToSourceId or f:compareToSourceExpression or f:compareToSourcePath)"
},
{
"key" : "tst-12",
"severity" : "error",
"human" : "Setup action assert response and responseCode SHALL be empty when direction equals request",
"expression" : "(response.empty() and responseCode.empty() and direction = 'request') or direction.empty() or direction = 'response'",
"xpath" : "((count(f:response) + count(f:responseCode)) = 0 and (f:direction/@value='request')) or (count(f:direction) = 0) or (f:direction/@value='response')"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TestScript.setup.action.assert.id",
"path" : "TestScript.setup.action.assert.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "TestScript.setup.action.assert.extension",
"path" : "TestScript.setup.action.assert.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "TestScript.setup.action.assert.modifierExtension",
"path" : "TestScript.setup.action.assert.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "TestScript.setup.action.assert.label",
"path" : "TestScript.setup.action.assert.label",
"short" : "Tracking/logging assertion label",
"definition" : "The label would be used for tracking/logging purposes by test engines.",
"comment" : "This has no impact on the verification itself.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TestScript.setup.action.assert.label",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TestScript.setup.action.assert.description",
"path" : "TestScript.setup.action.assert.description",
"short" : "Tracking/reporting assertion description",
"definition" : "The description would be used by test engines for tracking and reporting purposes.",
"comment" : "This has no impact on the verification itself.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TestScript.setup.action.assert.description",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TestScript.setup.action.assert.direction",
"path" : "TestScript.setup.action.assert.direction",
"short" : "response | request",
"definition" : "The direction to use for the assertion.",
"comment" : "If the direction is specified as \"response\" (the default), then the processing of this assert is against the received response message. If the direction is specified as \"request\", then the processing of this assert is against the sent request message.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TestScript.setup.action.assert.direction",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AssertionDirectionType"
}],
"strength" : "required",
"description" : "The type of direction to use for assertion.",
"valueSet" : "http://hl7.org/fhir/ValueSet/assert-direction-codes|4.0.1"
}
},
{
"id" : "TestScript.setup.action.assert.compareToSourceId",
"path" : "TestScript.setup.action.assert.compareToSourceId",
"short" : "Id of the source fixture to be evaluated",
"definition" : "Id of the source fixture used as the contents to be evaluated by either the \"source/expression\" or \"sourceId/path\" definition.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TestScript.setup.action.assert.compareToSourceId",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TestScript.setup.action.assert.compareToSourceExpression",
"path" : "TestScript.setup.action.assert.compareToSourceExpression",
"short" : "The FHIRPath expression to evaluate against the source fixture",
"definition" : "The FHIRPath expression to evaluate against the source fixture. When compareToSourceId is defined, either compareToSourceExpression or compareToSourcePath must be defined, but not both.",
"comment" : "Thefhirpath expression to be evaluated against the expected fixture to compare to. Ignored if \"assert.value\" is used. The evaluation will be done before the assertion is evaluated.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TestScript.setup.action.assert.compareToSourceExpression",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TestScript.setup.action.assert.compareToSourcePath",
"path" : "TestScript.setup.action.assert.compareToSourcePath",
"short" : "XPath or JSONPath expression to evaluate against the source fixture",
"definition" : "XPath or JSONPath expression to evaluate against the source fixture. When compareToSourceId is defined, either compareToSourceExpression or compareToSourcePath must be defined, but not both.",
"comment" : "The XPath or JSONPath expression to be evaluated against the expected fixture to compare to. Ignored if \"assert.value\" is used. The evaluation will be done before the assertion is evaluated.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TestScript.setup.action.assert.compareToSourcePath",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TestScript.setup.action.assert.contentType",
"path" : "TestScript.setup.action.assert.contentType",
"short" : "Mime type to compare against the 'Content-Type' header",
"definition" : "The mime-type contents to compare against the request or response message 'Content-Type' header.",
"comment" : "If this is specified, then test engine shall confirm that the content-type of the last operation's headers is set to this value. If \"assert.sourceId\" element is specified, then the evaluation will be done against the headers mapped to that sourceId (and not the last operation's headers). If you'd like to have more control over the string, then use 'assert.headerField' instead.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TestScript.setup.action.assert.contentType",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"example" : [{
"label" : "General",
"valueCode" : "application/fhir+xml"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MimeType"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "The mime type of an attachment. Any valid mime type is allowed.",
"valueSet" : "http://hl7.org/fhir/ValueSet/mimetypes|4.0.1"
}
},
{
"id" : "TestScript.setup.action.assert.expression",
"path" : "TestScript.setup.action.assert.expression",
"short" : "The FHIRPath expression to be evaluated",
"definition" : "The FHIRPath expression to be evaluated against the request or response message contents - HTTP headers and payload.",
"comment" : "If both \"expression\" and a \"fixtureId\" are specified, then the expression will be evaluated against the request or response body mapped to the fixtureId. If \"expression\" is specified and a \"fixtureId\" is not, then the expression will be evaluated against the response body of the last operation. Test engines are to store the request and response body and headers of the last operation at all times for subsequent assertions.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TestScript.setup.action.assert.expression",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TestScript.setup.action.assert.headerField",
"path" : "TestScript.setup.action.assert.headerField",
"short" : "HTTP header field name",
"definition" : "The HTTP header field name e.g. 'Location'.",
"comment" : "If \"headerField\" is specified then \"value\" must be specified. If \"sourceId\" is not specified, then \"headerField\" will be evaluated against the last operation's response headers. Test engines are to keep track of the last operation's response body and response headers.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TestScript.setup.action.assert.headerField",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TestScript.setup.action.assert.minimumId",
"path" : "TestScript.setup.action.assert.minimumId",
"short" : "Fixture Id of minimum content resource",
"definition" : "The ID of a fixture. Asserts that the response contains at a minimum the fixture specified by minimumId.",
"comment" : "Asserts that the response contains all the element/content in another fixture pointed to by minimumId. This can be a statically defined fixture or one that is dynamically set via responseId.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TestScript.setup.action.assert.minimumId",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TestScript.setup.action.assert.navigationLinks",
"path" : "TestScript.setup.action.assert.navigationLinks",
"short" : "Perform validation on navigation links?",
"definition" : "Whether or not the test execution performs validation on the bundle navigation links.",
"comment" : "Asserts that the Bundle contains first, last, and next links.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TestScript.setup.action.assert.navigationLinks",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TestScript.setup.action.assert.operator",
"path" : "TestScript.setup.action.assert.operator",
"short" : "equals | notEquals | in | notIn | greaterThan | lessThan | empty | notEmpty | contains | notContains | eval",
"definition" : "The operator type defines the conditional behavior of the assert. If not defined, the default is equals.",
"comment" : "Operators are useful especially for negative testing. If operator is not specified, then the \"equals\" operator is assumed; e.g. ``` ```.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TestScript.setup.action.assert.operator",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AssertionOperatorType"
}],
"strength" : "required",
"description" : "The type of operator to use for assertion.",
"valueSet" : "http://hl7.org/fhir/ValueSet/assert-operator-codes|4.0.1"
}
},
{
"id" : "TestScript.setup.action.assert.path",
"path" : "TestScript.setup.action.assert.path",
"short" : "XPath or JSONPath expression",
"definition" : "The XPath or JSONPath expression to be evaluated against the fixture representing the response received from server.",
"comment" : "If both \"path\" and a \"fixtureId\" are specified, then the path will be evaluated against the request or response body mapped to the fixtureId. If \"path\" is specified and a \"fixtureId\" is not, then the path will be evaluated against the response body of the last operation. Test engines are to store the request and response body and headers of the last operation at all times for subsequent assertions.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TestScript.setup.action.assert.path",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TestScript.setup.action.assert.requestMethod",
"path" : "TestScript.setup.action.assert.requestMethod",
"short" : "delete | get | options | patch | post | put | head",
"definition" : "The request method or HTTP operation code to compare against that used by the client system under test.",
"comment" : "If \"requestMethod\" is specified then it will be used in place of \"value\". The \"requestMethod\" will evaluate against the last operation's request HTTP operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TestScript.setup.action.assert.requestMethod",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "TestScriptRequestMethodCode"
}],
"strength" : "required",
"description" : "The allowable request method or HTTP operation codes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/http-operations|4.0.1"
}
},
{
"id" : "TestScript.setup.action.assert.requestURL",
"path" : "TestScript.setup.action.assert.requestURL",
"short" : "Request URL comparison value",
"definition" : "The value to use in a comparison against the request URL path string.",
"comment" : "If \"requestURL\" is specified then it will be used in place of \"value\". The \"requestURL\" will evaluate against the last operation's full request URL path string.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TestScript.setup.action.assert.requestURL",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TestScript.setup.action.assert.resource",
"path" : "TestScript.setup.action.assert.resource",
"short" : "Resource type",
"definition" : "The type of the resource. See http://build.fhir.org/resourcelist.html.",
"comment" : "This will be expected resource type in response body e.g. in read, vread, search, etc. See http://build.fhir.org/resourcelist.html for complete list of resource types; e.g. .",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TestScript.setup.action.assert.resource",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "FHIRDefinedType"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "A list of all the concrete types defined in this version of the FHIR specification - Data Types and Resource Types.",
"valueSet" : "http://hl7.org/fhir/ValueSet/defined-types|4.0.1"
}
},
{
"id" : "TestScript.setup.action.assert.response",
"path" : "TestScript.setup.action.assert.response",
"short" : "okay | created | noContent | notModified | bad | forbidden | notFound | methodNotAllowed | conflict | gone | preconditionFailed | unprocessable",
"definition" : "okay | created | noContent | notModified | bad | forbidden | notFound | methodNotAllowed | conflict | gone | preconditionFailed | unprocessable.",
"comment" : "This is a shorter way of achieving similar verifications via \"assert.responseCode\". If you need more control, then use \"assert.responseCode\" e.g. .",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TestScript.setup.action.assert.response",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AssertionResponseTypes"
}],
"strength" : "required",
"description" : "The type of response code to use for assertion.",
"valueSet" : "http://hl7.org/fhir/ValueSet/assert-response-code-types|4.0.1"
}
},
{
"id" : "TestScript.setup.action.assert.responseCode",
"path" : "TestScript.setup.action.assert.responseCode",
"short" : "HTTP response code to test",
"definition" : "The value of the HTTP response code to be tested.",
"comment" : "To be used with \"operator\" attribute value. Asserts that the response code equals this value if \"operator\" is not specified. If the operator is \"in\" or \"notIn\" then the responseCode would be a comma-separated list of values e.g. \"200,201\". Otherwise, it's expected to be a numeric value. If \"fixture\" is not specified, then the \"responseBodyId\" value of the last operation is assumed.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TestScript.setup.action.assert.responseCode",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TestScript.setup.action.assert.sourceId",
"path" : "TestScript.setup.action.assert.sourceId",
"short" : "Fixture Id of source expression or headerField",
"definition" : "Fixture to evaluate the XPath/JSONPath expression or the headerField against.",
"comment" : "This can be a statically defined fixture (at the top of the testscript) or a dynamically set fixture created by responseId of the action.operation element.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TestScript.setup.action.assert.sourceId",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "id"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TestScript.setup.action.assert.validateProfileId",
"path" : "TestScript.setup.action.assert.validateProfileId",
"short" : "Profile Id of validation profile reference",
"definition" : "The ID of the Profile to validate against.",
"comment" : "The ID of a Profile fixture. Asserts that the response is valid according to the Profile specified by validateProfileId.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TestScript.setup.action.assert.validateProfileId",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "id"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TestScript.setup.action.assert.value",
"path" : "TestScript.setup.action.assert.value",
"short" : "The value to compare to",
"definition" : "The value to compare to.",
"comment" : "The string-representation of a number, string, or boolean that is expected. Test engines do have to look for placeholders (${}) and replace the variable placeholders with the variable values at runtime before comparing this value to the actual value.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TestScript.setup.action.assert.value",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TestScript.setup.action.assert.warningOnly",
"path" : "TestScript.setup.action.assert.warningOnly",
"short" : "Will this assert produce a warning only on error?",
"definition" : "Whether or not the test execution will produce a warning only on error for this assert.",
"comment" : "If this element is specified and it is true, then assertion failures can be logged by test engine but should not stop the test script execution from proceeding. There are likely cases where the spec is not clear on what should happen. If the spec says something is optional (maybe a response header for example), but a server doesn’t do it, we could choose to issue a warning.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "TestScript.setup.action.assert.warningOnly",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TestScript.test",
"path" : "TestScript.test",
"short" : "A test in this script",
"definition" : "A test in this script.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "TestScript.test",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TestScript.test.id",
"path" : "TestScript.test.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "TestScript.test.extension",
"path" : "TestScript.test.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "TestScript.test.modifierExtension",
"path" : "TestScript.test.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "TestScript.test.name",
"path" : "TestScript.test.name",
"short" : "Tracking/logging name of this test",
"definition" : "The name of this test used for tracking/logging purposes by test engines.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TestScript.test.name",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TestScript.test.description",
"path" : "TestScript.test.description",
"short" : "Tracking/reporting short description of the test",
"definition" : "A short description of the test used by test engines for tracking and reporting purposes.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TestScript.test.description",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TestScript.test.action",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "TestAction"
}],
"path" : "TestScript.test.action",
"short" : "A test operation or assert to perform",
"definition" : "Action would contain either an operation or an assertion.",
"comment" : "An action should contain either an operation or an assertion but not both. It can contain any number of variables.",
"min" : 1,
"max" : "*",
"base" : {
"path" : "TestScript.test.action",
"min" : 1,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "tst-2",
"severity" : "error",
"human" : "Test action SHALL contain either an operation or assert but not both.",
"expression" : "operation.exists() xor assert.exists()",
"xpath" : "(f:operation or f:assert) and not(f:operation and f:assert)"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TestScript.test.action.id",
"path" : "TestScript.test.action.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "TestScript.test.action.extension",
"path" : "TestScript.test.action.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "TestScript.test.action.modifierExtension",
"path" : "TestScript.test.action.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "TestScript.test.action.operation",
"path" : "TestScript.test.action.operation",
"short" : "The setup operation to perform",
"definition" : "An operation would involve a REST request to a server.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TestScript.test.action.operation",
"min" : 0,
"max" : "1"
},
"contentReference" : "#TestScript.setup.action.operation",
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "tst-8",
"severity" : "error",
"human" : "Test operation SHALL contain either sourceId or targetId or params or url.",
"expression" : "sourceId.exists() or (targetId.count() + url.count() + params.count() = 1) or (type.code in ('capabilities' | 'search' | 'transaction' | 'history'))",
"xpath" : "f:sourceId or (f:targetId or f:url or f:params) and (count(f:targetId) + count(f:url) + count(f:params) =1) or (f:type/f:code/@value='capabilities' or f:type/f:code/@value='search' or f:type/f:code/@value='transaction' or f:type/f:code/@value='history')"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TestScript.test.action.assert",
"path" : "TestScript.test.action.assert",
"short" : "The setup assertion to perform",
"definition" : "Evaluates the results of previous operations to determine if the server under test behaves appropriately.",
"comment" : "In order to evaluate an assertion, the request, response, and results of the most recently executed operation must always be maintained by the test engine.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TestScript.test.action.assert",
"min" : 0,
"max" : "1"
},
"contentReference" : "#TestScript.setup.action.assert",
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "tst-6",
"severity" : "error",
"human" : "Only a single assertion SHALL be present within test action assert element.",
"expression" : "extension.exists() or (contentType.count() + expression.count() + headerField.count() + minimumId.count() + navigationLinks.count() + path.count() + requestMethod.count() + resource.count() + responseCode.count() + response.count() + validateProfileId.count() <=1)",
"xpath" : "count(f:contentType) + count(f:expression) + count(f:headerField) + count(f:minimumId) + count(f:navigationLinks) + count(f:path) + count(f:requestMethod) + count(f:resource) + count(f:responseCode) + count(f:response) + count(f:rule) + count(f:ruleset) + count(f:validateProfileId) <=1"
},
{
"key" : "tst-11",
"severity" : "error",
"human" : "Test action assert SHALL contain either compareToSourceId and compareToSourceExpression, compareToSourceId and compareToSourcePath or neither.",
"expression" : "compareToSourceId.empty() xor (compareToSourceExpression.exists() or compareToSourcePath.exists())",
"xpath" : "(f:compareToSourceId and f:compareToSourceExpression) or (f:compareToSourceId and f:compareToSourcePath) or not(f:compareToSourceId or f:compareToSourceExpression or f:compareToSourcePath)"
},
{
"key" : "tst-13",
"severity" : "error",
"human" : "Test action assert response and response and responseCode SHALL be empty when direction equals request",
"expression" : "(response.empty() and responseCode.empty() and direction = 'request') or direction.empty() or direction = 'response'",
"xpath" : "((count(f:response) + count(f:responseCode)) = 0 and (f:direction/@value='request')) or (count(f:direction) = 0) or (f:direction/@value='response')"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TestScript.teardown",
"path" : "TestScript.teardown",
"short" : "A series of required clean up steps",
"definition" : "A series of operations required to clean up after all the tests are executed (successfully or otherwise).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TestScript.teardown",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TestScript.teardown.id",
"path" : "TestScript.teardown.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "TestScript.teardown.extension",
"path" : "TestScript.teardown.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "TestScript.teardown.modifierExtension",
"path" : "TestScript.teardown.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "TestScript.teardown.action",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "TeardownAction"
}],
"path" : "TestScript.teardown.action",
"short" : "One or more teardown operations to perform",
"definition" : "The teardown action will only contain an operation.",
"comment" : "An action should contain either an operation or an assertion but not both. It can contain any number of variables.",
"min" : 1,
"max" : "*",
"base" : {
"path" : "TestScript.teardown.action",
"min" : 1,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TestScript.teardown.action.id",
"path" : "TestScript.teardown.action.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "TestScript.teardown.action.extension",
"path" : "TestScript.teardown.action.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "TestScript.teardown.action.modifierExtension",
"path" : "TestScript.teardown.action.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "TestScript.teardown.action.operation",
"path" : "TestScript.teardown.action.operation",
"short" : "The teardown operation to perform",
"definition" : "An operation would involve a REST request to a server.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "TestScript.teardown.action.operation",
"min" : 1,
"max" : "1"
},
"contentReference" : "#TestScript.setup.action.operation",
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "tst-9",
"severity" : "error",
"human" : "Teardown operation SHALL contain either sourceId or targetId or params or url.",
"expression" : "sourceId.exists() or (targetId.count() + url.count() + params.count() = 1) or (type.code in ('capabilities' | 'search' | 'transaction' | 'history'))",
"xpath" : "f:sourceId or (f:targetId or f:url or (f:params and f:resource)) and (count(f:targetId) + count(f:url) + count(f:params) =1) or (f:type/f:code/@value='capabilities' or f:type/f:code/@value='search' or f:type/f:code/@value='transaction' or f:type/f:code/@value='history')"
}],
"isModifier" : false,
"isSummary" : false
}]
},
"differential" : {
"element" : [{
"id" : "TestScript",
"path" : "TestScript",
"short" : "Describes a set of tests",
"definition" : "A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.",
"min" : 0,
"max" : "*",
"constraint" : [{
"key" : "tst-0",
"severity" : "warning",
"human" : "Name should be usable as an identifier for the module by machine processing applications such as code generation",
"expression" : "name.matches('[A-Z]([A-Za-z0-9_]){0,254}')",
"xpath" : "not(exists(f:name/@value)) or matches(f:name/@value, '[A-Z]([A-Za-z0-9_]){0,254}')"
}],
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "TestScript.url",
"path" : "TestScript.url",
"short" : "Canonical identifier for this test script, represented as a URI (globally unique)",
"definition" : "An absolute URI that is used to identify this test script when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this test script is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the test script is stored on different servers.",
"comment" : "Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.\n\nThe determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions). \n\nIn some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.",
"requirements" : "Allows the test script to be referenced by a single globally unique identifier.",
"alias" : ["url",
"authoritative-url",
"destination",
"identity"],
"min" : 1,
"max" : "1",
"type" : [{
"code" : "uri"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.url"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
}]
},
{
"id" : "TestScript.identifier",
"path" : "TestScript.identifier",
"short" : "Additional identifier for the test script",
"definition" : "A formal identifier that is used to identify this test script when it is represented in other formats, or referenced in a specification, model, design or an instance.",
"comment" : "Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this test script outside of FHIR, where it is not possible to use the logical URI.",
"requirements" : "Allows externally provided and/or usable business identifiers to be easily associated with the module.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Identifier"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.identifier"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "TestScript.version",
"path" : "TestScript.version",
"short" : "Business version of the test script",
"definition" : "The identifier that is used to identify this version of the test script when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the test script author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.",
"comment" : "There may be different test script instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the test script with the format [url]|[version].",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.version"
},
{
"identity" : "w5",
"map" : "FiveWs.version"
}]
},
{
"id" : "TestScript.name",
"path" : "TestScript.name",
"short" : "Name for this test script (computer friendly)",
"definition" : "A natural language name identifying the test script. This name should be usable as an identifier for the module by machine processing applications such as code generation.",
"comment" : "The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.",
"requirements" : "Support human navigation and code generation.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "string"
}],
"condition" : ["inv-0"],
"isSummary" : true
},
{
"id" : "TestScript.title",
"path" : "TestScript.title",
"short" : "Name for this test script (human friendly)",
"definition" : "A short, descriptive, user-friendly title for the test script.",
"comment" : "This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.title"
}]
},
{
"id" : "TestScript.status",
"path" : "TestScript.status",
"short" : "draft | active | retired | unknown",
"definition" : "The status of this test script. Enables tracking the life-cycle of the content.",
"comment" : "Allows filtering of test scripts that are appropriate for use versus not.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isModifier" : true,
"isModifierReason" : "This is labeled as \"Is Modifier\" because applications should not use a retired {{title}} without due consideration",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "PublicationStatus"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "The lifecycle status of an artifact.",
"valueSet" : "http://hl7.org/fhir/ValueSet/publication-status|4.0.1"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.status"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
}]
},
{
"id" : "TestScript.experimental",
"path" : "TestScript.experimental",
"short" : "For testing purposes, not real usage",
"definition" : "A Boolean value to indicate that this test script is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.",
"comment" : "Allows filtering of test scripts that are appropriate for use versus not.",
"requirements" : "Enables experimental content to be developed following the same lifecycle that would be used for a production-level test script.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "boolean"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.experimental"
},
{
"identity" : "w5",
"map" : "FiveWs.class"
}]
},
{
"id" : "TestScript.date",
"path" : "TestScript.date",
"short" : "Date last changed",
"definition" : "The date (and optionally time) when the test script was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the test script changes.",
"comment" : "Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the test script. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.",
"alias" : ["Revision Date"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "dateTime"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.date"
},
{
"identity" : "w5",
"map" : "FiveWs.recorded"
}]
},
{
"id" : "TestScript.publisher",
"path" : "TestScript.publisher",
"short" : "Name of the publisher (organization or individual)",
"definition" : "The name of the organization or individual that published the test script.",
"comment" : "Usually an organization but may be an individual. The publisher (or steward) of the test script is the organization or individual primarily responsible for the maintenance and upkeep of the test script. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the test script. This item SHOULD be populated unless the information is available from context.",
"requirements" : "Helps establish the \"authority/credibility\" of the test script. May also allow for contact.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.publisher"
},
{
"identity" : "w5",
"map" : "FiveWs.witness"
}]
},
{
"id" : "TestScript.contact",
"path" : "TestScript.contact",
"short" : "Contact details for the publisher",
"definition" : "Contact details to assist a user in finding and communicating with the publisher.",
"comment" : "May be a web site, an email address, a telephone number, etc.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "ContactDetail"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.contact"
}]
},
{
"id" : "TestScript.description",
"path" : "TestScript.description",
"short" : "Natural language description of the test script",
"definition" : "A free text natural language description of the test script from a consumer's perspective.",
"comment" : "This description can be used to capture details such as why the test script was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the test script as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the test script is presumed to be the predominant language in the place the test script was created).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "markdown"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.description"
}]
},
{
"id" : "TestScript.useContext",
"path" : "TestScript.useContext",
"short" : "The context that the content is intended to support",
"definition" : "The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate test script instances.",
"comment" : "When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.",
"requirements" : "Assist in searching for appropriate content.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "UsageContext"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.useContext"
}]
},
{
"id" : "TestScript.jurisdiction",
"path" : "TestScript.jurisdiction",
"short" : "Intended jurisdiction for test script (if applicable)",
"definition" : "A legal or geographic region in which the test script is intended to be used.",
"comment" : "It may be possible for the test script to be used in jurisdictions other than those for which it was originally designed or intended.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Jurisdiction"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "extensible",
"description" : "Countries and regions within which this artifact is targeted for use.",
"valueSet" : "http://hl7.org/fhir/ValueSet/jurisdiction"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.jurisdiction"
}]
},
{
"id" : "TestScript.purpose",
"path" : "TestScript.purpose",
"short" : "Why this test script is defined",
"definition" : "Explanation of why this test script is needed and why it has been designed as it has.",
"comment" : "This element does not describe the usage of the test script. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this test script.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "markdown"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.purpose"
},
{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "TestScript.copyright",
"path" : "TestScript.copyright",
"short" : "Use and/or publishing restrictions",
"definition" : "A copyright statement relating to the test script and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the test script.",
"requirements" : "Consumers must be able to determine any legal restrictions on the use of the test script and/or its content.",
"alias" : ["License",
"Restrictions"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "markdown"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.copyright"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "TestScript.origin",
"path" : "TestScript.origin",
"short" : "An abstract server representing a client or sender in a message exchange",
"definition" : "An abstract server used in operations within this test script in the origin element.",
"comment" : "The purpose of this element is to define the profile of an origin element used elsewhere in the script. Test engines could then use the origin-profile mapping to offer a filtered list of test systems that can serve as the sender for the interaction.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "TestScript.origin.index",
"path" : "TestScript.origin.index",
"short" : "The index of the abstract origin server starting at 1",
"definition" : "Abstract name given to an origin server in this test script. The name is provided as a number starting at 1.",
"comment" : "A given origin index (e.g. 1) can appear only once in the list (e.g. Origin 1 cannot be specified twice ... once as FormFiller and again as FormProcessor within the same script as that could get confusing during test configuration). \n\nDifferent origin indices could play the same actor in the same test script (e.g. You could have two different test systems acting as Form-Filler).\n\nThe origin indices provided elsewhere in the test script must be one of these origin indices.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "integer"
}]
},
{
"id" : "TestScript.origin.profile",
"path" : "TestScript.origin.profile",
"short" : "FHIR-Client | FHIR-SDC-FormFiller",
"definition" : "The type of origin profile the test system supports.",
"comment" : "Must be a \"sender\"/\"client\" profile.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "Coding"
}],
"meaningWhenMissing" : "FHIR-Client",
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "TestScriptProfileOriginType"
}],
"strength" : "extensible",
"description" : "The type of origin profile the test system supports.",
"valueSet" : "http://hl7.org/fhir/ValueSet/testscript-profile-origin-types"
}
},
{
"id" : "TestScript.destination",
"path" : "TestScript.destination",
"short" : "An abstract server representing a destination or receiver in a message exchange",
"definition" : "An abstract server used in operations within this test script in the destination element.",
"comment" : "The purpose of this element is to define the profile of a destination element used elsewhere in the script. Test engines could then use the destination-profile mapping to offer a filtered list of test systems that can serve as the receiver for the interaction.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "TestScript.destination.index",
"path" : "TestScript.destination.index",
"short" : "The index of the abstract destination server starting at 1",
"definition" : "Abstract name given to a destination server in this test script. The name is provided as a number starting at 1.",
"comment" : "A given destination index (e.g. 1) can appear only once in the list (e.g. Destination 1 cannot be specified twice ... once as Form-Manager and again as Form-Processor within the same script as that could get confusing during test configuration). \n\nDifferent destination indices could play the same actor in the same test script (e.g. You could have two different test systems acting as Form-Manager).\n\nThe destination indices provided elsewhere in the test script must be one of these destination indices.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "integer"
}]
},
{
"id" : "TestScript.destination.profile",
"path" : "TestScript.destination.profile",
"short" : "FHIR-Server | FHIR-SDC-FormManager | FHIR-SDC-FormReceiver | FHIR-SDC-FormProcessor",
"definition" : "The type of destination profile the test system supports.",
"comment" : "Must be a \"receiver\"/\"server\" profile.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "Coding"
}],
"meaningWhenMissing" : "FHIR-Server",
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "TestScriptProfileDestinationType"
}],
"strength" : "extensible",
"description" : "The type of destination profile the test system supports.",
"valueSet" : "http://hl7.org/fhir/ValueSet/testscript-profile-destination-types"
}
},
{
"id" : "TestScript.metadata",
"path" : "TestScript.metadata",
"short" : "Required capability that is assumed to function correctly on the FHIR server being tested",
"definition" : "The required capability must exist and are assumed to function correctly on the FHIR server being tested.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "tst-4",
"severity" : "error",
"human" : "TestScript metadata capability SHALL contain required or validated or both.",
"expression" : "capability.required.exists() or capability.validated.exists()",
"xpath" : "f:capability/f:required or f:capability/f:validated or (f:capability/f:required and f:capability/f:validated)"
}]
},
{
"id" : "TestScript.metadata.link",
"path" : "TestScript.metadata.link",
"short" : "Links to the FHIR specification",
"definition" : "A link to the FHIR specification that this test is covering.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "TestScript.metadata.link.url",
"path" : "TestScript.metadata.link.url",
"short" : "URL to the specification",
"definition" : "URL to a particular requirement or feature within the FHIR specification.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "uri"
}]
},
{
"id" : "TestScript.metadata.link.description",
"path" : "TestScript.metadata.link.description",
"short" : "Short description",
"definition" : "Short description of the link.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}]
},
{
"id" : "TestScript.metadata.capability",
"path" : "TestScript.metadata.capability",
"short" : "Capabilities that are assumed to function correctly on the FHIR server being tested",
"definition" : "Capabilities that must exist and are assumed to function correctly on the FHIR server being tested.",
"comment" : "When the metadata capabilities section is defined at TestScript.metadata or at TestScript.setup.metadata, and the server's conformance statement does not contain the elements defined in the minimal conformance statement, then all the tests in the TestScript are skipped. When the metadata capabilities section is defined at TestScript.test.metadata and the server's conformance statement does not contain the elements defined in the minimal conformance statement, then only that test is skipped. The \"metadata.capabilities.required\" and \"metadata.capabilities.validated\" elements only indicate whether the capabilities are the primary focus of the test script or not. They do not impact the skipping logic. Capabilities whose \"metadata.capabilities.validated\" flag is true are the primary focus of the test script.",
"min" : 1,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "TestScript.metadata.capability.required",
"path" : "TestScript.metadata.capability.required",
"short" : "Are the capabilities required?",
"definition" : "Whether or not the test execution will require the given capabilities of the server in order for this test script to execute.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "boolean"
}]
},
{
"id" : "TestScript.metadata.capability.validated",
"path" : "TestScript.metadata.capability.validated",
"short" : "Are the capabilities validated?",
"definition" : "Whether or not the test execution will validate the given capabilities of the server in order for this test script to execute.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "boolean"
}]
},
{
"id" : "TestScript.metadata.capability.description",
"path" : "TestScript.metadata.capability.description",
"short" : "The expected capabilities of the server",
"definition" : "Description of the capabilities that this test script is requiring the server to support.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}]
},
{
"id" : "TestScript.metadata.capability.origin",
"path" : "TestScript.metadata.capability.origin",
"short" : "Which origin server these requirements apply to",
"definition" : "Which origin server these requirements apply to.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "integer"
}]
},
{
"id" : "TestScript.metadata.capability.destination",
"path" : "TestScript.metadata.capability.destination",
"short" : "Which server these requirements apply to",
"definition" : "Which server these requirements apply to.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "integer"
}]
},
{
"id" : "TestScript.metadata.capability.link",
"path" : "TestScript.metadata.capability.link",
"short" : "Links to the FHIR specification",
"definition" : "Links to the FHIR specification that describes this interaction and the resources involved in more detail.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "uri"
}]
},
{
"id" : "TestScript.metadata.capability.capabilities",
"path" : "TestScript.metadata.capability.capabilities",
"short" : "Required Capability Statement",
"definition" : "Minimum capabilities required of server for test script to execute successfully. If server does not meet at a minimum the referenced capability statement, then all tests in this script are skipped.",
"comment" : "The conformance statement of the server has to contain at a minimum the contents of the reference pointed to by this element.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/CapabilityStatement"]
}]
},
{
"id" : "TestScript.fixture",
"path" : "TestScript.fixture",
"short" : "Fixture in the test script - by reference (uri)",
"definition" : "Fixture in the test script - by reference (uri). All fixtures are required for the test script to execute.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "TestScript.fixture.autocreate",
"path" : "TestScript.fixture.autocreate",
"short" : "Whether or not to implicitly create the fixture during setup",
"definition" : "Whether or not to implicitly create the fixture during setup. If true, the fixture is automatically created on each server being tested during setup, therefore no create operation is required for this fixture in the TestScript.setup section.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "boolean"
}]
},
{
"id" : "TestScript.fixture.autodelete",
"path" : "TestScript.fixture.autodelete",
"short" : "Whether or not to implicitly delete the fixture during teardown",
"definition" : "Whether or not to implicitly delete the fixture during teardown. If true, the fixture is automatically deleted on each server being tested during teardown, therefore no delete operation is required for this fixture in the TestScript.teardown section.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "boolean"
}]
},
{
"id" : "TestScript.fixture.resource",
"path" : "TestScript.fixture.resource",
"short" : "Reference of the resource",
"definition" : "Reference to the resource (containing the contents of the resource needed for operations).",
"comment" : "See http://build.fhir.org/resourcelist.html for complete list of resource types.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}]
},
{
"id" : "TestScript.profile",
"path" : "TestScript.profile",
"short" : "Reference of the validation profile",
"definition" : "Reference to the profile to be used for validation.",
"comment" : "See http://build.fhir.org/resourcelist.html for complete list of resource types.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}]
},
{
"id" : "TestScript.variable",
"path" : "TestScript.variable",
"short" : "Placeholder for evaluated elements",
"definition" : "Variable is set based either on element value in response body or on header field value in the response headers.",
"comment" : "Variables would be set based either on XPath/JSONPath expressions against fixtures (static and response), or headerField evaluations against response headers. If variable evaluates to nodelist or anything other than a primitive value, then test engine would report an error. Variables would be used to perform clean replacements in \"operation.params\", \"operation.requestHeader.value\", and \"operation.url\" element values during operation calls and in \"assert.value\" during assertion evaluations. This limits the places that test engines would need to look for placeholders \"${}\". Variables are scoped to the whole script. They are NOT evaluated at declaration. They are evaluated by test engine when used for substitutions in \"operation.params\", \"operation.requestHeader.value\", and \"operation.url\" element values during operation calls and in \"assert.value\" during assertion evaluations. See example testscript-search.xml.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "tst-3",
"severity" : "error",
"human" : "Variable can only contain one of expression, headerField or path.",
"expression" : "expression.empty() or headerField.empty() or path.empty()",
"xpath" : "not(f:expression and f:headerField and f:path)"
}]
},
{
"id" : "TestScript.variable.name",
"path" : "TestScript.variable.name",
"short" : "Descriptive name for this variable",
"definition" : "Descriptive name for this variable.",
"comment" : "Placeholders would contain the variable name wrapped in ${} in \"operation.params\", \"operation.requestHeader.value\", and \"operation.url\" elements. These placeholders would need to be replaced by the variable value before the operation is executed.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "string"
}]
},
{
"id" : "TestScript.variable.defaultValue",
"path" : "TestScript.variable.defaultValue",
"short" : "Default, hard-coded, or user-defined value for this variable",
"definition" : "A default, hard-coded, or user-defined value for this variable.",
"comment" : "The purpose of this element is to allow for a pre-defined value that can be used as a default or as an override value. Test engines can optionally use this as a placeholder for user-defined execution time values.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}]
},
{
"id" : "TestScript.variable.description",
"path" : "TestScript.variable.description",
"short" : "Natural language description of the variable",
"definition" : "A free text natural language description of the variable and its purpose.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}]
},
{
"id" : "TestScript.variable.expression",
"path" : "TestScript.variable.expression",
"short" : "The FHIRPath expression against the fixture body",
"definition" : "The FHIRPath expression to evaluate against the fixture body. When variables are defined, only one of either expression, headerField or path must be specified.",
"comment" : "If headerField is defined, then the variable will be evaluated against the headers that sourceId is pointing to. If expression or path is defined, then the variable will be evaluated against the fixture body that sourceId is pointing to. It is an error to define any combination of expression, headerField and path.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}]
},
{
"id" : "TestScript.variable.headerField",
"path" : "TestScript.variable.headerField",
"short" : "HTTP header field name for source",
"definition" : "Will be used to grab the HTTP header field value from the headers that sourceId is pointing to.",
"comment" : "If headerField is defined, then the variable will be evaluated against the headers that sourceId is pointing to. If path is defined, then the variable will be evaluated against the fixture body that sourceId is pointing to. It is an error to define both headerField and path.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}]
},
{
"id" : "TestScript.variable.hint",
"path" : "TestScript.variable.hint",
"short" : "Hint help text for default value to enter",
"definition" : "Displayable text string with hint help information to the user when entering a default value.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}]
},
{
"id" : "TestScript.variable.path",
"path" : "TestScript.variable.path",
"short" : "XPath or JSONPath against the fixture body",
"definition" : "XPath or JSONPath to evaluate against the fixture body. When variables are defined, only one of either expression, headerField or path must be specified.",
"comment" : "If headerField is defined, then the variable will be evaluated against the headers that sourceId is pointing to. If expression or path is defined, then the variable will be evaluated against the fixture body that sourceId is pointing to. It is an error to define any combination of expression, headerField and path.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}]
},
{
"id" : "TestScript.variable.sourceId",
"path" : "TestScript.variable.sourceId",
"short" : "Fixture Id of source expression or headerField within this variable",
"definition" : "Fixture to evaluate the XPath/JSONPath expression or the headerField against within this variable.",
"comment" : "This can be a statically defined fixture (at the top of the TestScript) or a dynamically set fixture created by responseId of the `action.operation` element.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "id"
}]
},
{
"id" : "TestScript.setup",
"path" : "TestScript.setup",
"short" : "A series of required setup operations before tests are executed",
"definition" : "A series of required setup operations before tests are executed.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "TestScript.setup.action",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "SetupAction"
}],
"path" : "TestScript.setup.action",
"short" : "A setup operation or assert to perform",
"definition" : "Action would contain either an operation or an assertion.",
"comment" : "An action should contain either an operation or an assertion but not both. It can contain any number of variables.",
"min" : 1,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "tst-1",
"severity" : "error",
"human" : "Setup action SHALL contain either an operation or assert but not both.",
"expression" : "operation.exists() xor assert.exists()",
"xpath" : "(f:operation or f:assert) and not(f:operation and f:assert)"
}]
},
{
"id" : "TestScript.setup.action.operation",
"path" : "TestScript.setup.action.operation",
"short" : "The setup operation to perform",
"definition" : "The operation to perform.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "tst-7",
"severity" : "error",
"human" : "Setup operation SHALL contain either sourceId or targetId or params or url.",
"expression" : "sourceId.exists() or (targetId.count() + url.count() + params.count() = 1) or (type.code in ('capabilities' |'search' | 'transaction' | 'history'))",
"xpath" : "f:sourceId or ((f:targetId or f:url or f:params) and (count(f:targetId) + count(f:url) + count(f:params) =1)) or (f:type/f:code/@value='capabilities' or f:type/f:code/@value='search' or f:type/f:code/@value='transaction' or f:type/f:code/@value='history')"
}]
},
{
"id" : "TestScript.setup.action.operation.type",
"path" : "TestScript.setup.action.operation.type",
"short" : "The operation code type that will be executed",
"definition" : "Server interaction or operation type.",
"comment" : "See http://build.fhir.org/http.html for list of server interactions.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Coding"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "TestScriptOperationCode"
}],
"strength" : "extensible",
"description" : "The allowable operation code types.",
"valueSet" : "http://hl7.org/fhir/ValueSet/testscript-operation-codes"
}
},
{
"id" : "TestScript.setup.action.operation.resource",
"path" : "TestScript.setup.action.operation.resource",
"short" : "Resource type",
"definition" : "The type of the resource. See http://build.fhir.org/resourcelist.html.",
"comment" : "If \"url\" element is specified, then \"targetId\", \"params\", and \"resource\" elements will be ignored as \"url\" element will have everything needed for constructing the request url. If \"params\" element is specified, then \"targetId\" element is ignored. For FHIR operations that require a resource (e.g. \"read\" and \"vread\" operations), the \"resource\" element must be specified when \"params\" element is specified. If \"url\" and \"params\" elements are absent, then the request url will be constructed from \"targetId\" fixture if present. For \"read\" operation, the resource and id values will be extracted from \"targetId\" fixture and used to construct the url. For \"vread\" and \"history\" operations, the versionId value will also be used.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "code"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "FHIRDefinedType"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "A list of all the concrete types defined in this version of the FHIR specification - Data Types and Resource Types.",
"valueSet" : "http://hl7.org/fhir/ValueSet/defined-types|4.0.1"
}
},
{
"id" : "TestScript.setup.action.operation.label",
"path" : "TestScript.setup.action.operation.label",
"short" : "Tracking/logging operation label",
"definition" : "The label would be used for tracking/logging purposes by test engines.",
"comment" : "This has no impact on the verification itself.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}]
},
{
"id" : "TestScript.setup.action.operation.description",
"path" : "TestScript.setup.action.operation.description",
"short" : "Tracking/reporting operation description",
"definition" : "The description would be used by test engines for tracking and reporting purposes.",
"comment" : "This has no impact on the verification itself.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}]
},
{
"id" : "TestScript.setup.action.operation.accept",
"path" : "TestScript.setup.action.operation.accept",
"short" : "Mime type to accept in the payload of the response, with charset etc.",
"definition" : "The mime-type to use for RESTful operation in the 'Accept' header.",
"comment" : "If this is specified, then test engine shall set the 'Accept' header to the corresponding value. If you'd like to explicitly set the 'Accept' to some other value then use the 'requestHeader' element.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "code"
}],
"example" : [{
"label" : "General",
"valueCode" : "application/fhir+xml"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MimeType"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "The mime type of an attachment. Any valid mime type is allowed.",
"valueSet" : "http://hl7.org/fhir/ValueSet/mimetypes|4.0.1"
}
},
{
"id" : "TestScript.setup.action.operation.contentType",
"path" : "TestScript.setup.action.operation.contentType",
"short" : "Mime type of the request payload contents, with charset etc.",
"definition" : "The mime-type to use for RESTful operation in the 'Content-Type' header.",
"comment" : "If this is specified, then test engine shall set the 'Content-Type' header to the corresponding value. If you'd like to explicitly set the 'Content-Type' to some other value then use the 'requestHeader' element.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "code"
}],
"example" : [{
"label" : "General",
"valueCode" : "application/fhir+xml"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MimeType"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "The mime type of an attachment. Any valid mime type is allowed.",
"valueSet" : "http://hl7.org/fhir/ValueSet/mimetypes|4.0.1"
}
},
{
"id" : "TestScript.setup.action.operation.destination",
"path" : "TestScript.setup.action.operation.destination",
"short" : "Server responding to the request",
"definition" : "The server where the request message is destined for. Must be one of the server numbers listed in TestScript.destination section.",
"comment" : "If multiple TestScript.destination elements are defined and operation.destination is undefined, test engine will report an error as it cannot determine what destination to use for the exchange.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "integer"
}]
},
{
"id" : "TestScript.setup.action.operation.encodeRequestUrl",
"path" : "TestScript.setup.action.operation.encodeRequestUrl",
"short" : "Whether or not to send the request url in encoded format",
"definition" : "Whether or not to implicitly send the request url in encoded format. The default is true to match the standard RESTful client behavior. Set to false when communicating with a server that does not support encoded url paths.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "boolean"
}]
},
{
"id" : "TestScript.setup.action.operation.method",
"path" : "TestScript.setup.action.operation.method",
"short" : "delete | get | options | patch | post | put | head",
"definition" : "The HTTP method the test engine MUST use for this operation regardless of any other operation details.",
"comment" : "The primary purpose of the explicit HTTP method is support of HTTP POST method invocation of the FHIR search. Other uses will include support of negative testing.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "code"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "TestScriptRequestMethodCode"
}],
"strength" : "required",
"description" : "The allowable request method or HTTP operation codes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/http-operations|4.0.1"
}
},
{
"id" : "TestScript.setup.action.operation.origin",
"path" : "TestScript.setup.action.operation.origin",
"short" : "Server initiating the request",
"definition" : "The server where the request message originates from. Must be one of the server numbers listed in TestScript.origin section.",
"comment" : "If absent, test engine will send the message. When present, test engine will not send the request message but will wait for the request message to be sent from this origin server.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "integer"
}]
},
{
"id" : "TestScript.setup.action.operation.params",
"path" : "TestScript.setup.action.operation.params",
"short" : "Explicitly defined path parameters",
"definition" : "Path plus parameters after [type]. Used to set parts of the request URL explicitly.",
"comment" : "If \"url\" element is specified, then \"targetId\", \"params\", and \"resource\" elements will be ignored as \"url\" element will have everything needed for constructing the request url. If \"params\" element is specified, then \"targetId\" element is ignored. For FHIR operations that require a resource (e.g. \"read\" and \"vread\" operations), the \"resource\" element must be specified when \"params\" element is specified. If \"url\" and \"params\" elements are absent, then the request url will be constructed from \"targetId\" fixture if present. For \"read\" operation, the resource and id values will be extracted from \"targetId\" fixture and used to construct the url. For \"vread\" and \"history\" operations, the versionId value will also be used. Test engines would append whatever is specified for \"params\" to the URL after the resource type without tampering with the string (beyond encoding the URL for HTTP). The \"params\" element does not correspond exactly to \"search parameters\". Nor is it the \"path\". It corresponds to the part of the URL that comes after the [type] (when \"resource\" element is specified); e.g. It corresponds to \"/[id]/_history/[vid] {?_format=[mime-type]}\" in the following operation: GET [base]/[type]/[id]/_history/[vid] {?_format=[mime-type]} Test engines do have to look for placeholders (${}) and replace the variable placeholders with the variable values at runtime before sending the request.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}]
},
{
"id" : "TestScript.setup.action.operation.requestHeader",
"path" : "TestScript.setup.action.operation.requestHeader",
"short" : "Each operation can have one or more header elements",
"definition" : "Header elements would be used to set HTTP headers.",
"comment" : "This gives control to test-script writers to set headers explicitly based on test requirements. It will allow for testing using: - \"If-Modified-Since\" and \"If-None-Match\" headers. See http://build.fhir.org/http.html#2.1.0.5.1 - \"If-Match\" header. See http://build.fhir.org/http.html#2.1.0.11 - Conditional Create using \"If-None-Exist\". See http://build.fhir.org/http.html#2.1.0.13.1 - Invalid \"Content-Type\" header for negative testing. - etc.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "TestScript.setup.action.operation.requestHeader.field",
"path" : "TestScript.setup.action.operation.requestHeader.field",
"short" : "HTTP header field name",
"definition" : "The HTTP header field e.g. \"Accept\".",
"comment" : "If header element is specified, then field is required.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "string"
}]
},
{
"id" : "TestScript.setup.action.operation.requestHeader.value",
"path" : "TestScript.setup.action.operation.requestHeader.value",
"short" : "HTTP headerfield value",
"definition" : "The value of the header e.g. \"application/fhir+xml\".",
"comment" : "If header element is specified, then value is required. No conversions will be done by the test engine e.g. \"xml\" to \"application/fhir+xml\". The values will be set in HTTP headers \"as-is\". Test engines do have to look for placeholders (${}) and replace the variable placeholders with the variable values at runtime before sending the request.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "string"
}]
},
{
"id" : "TestScript.setup.action.operation.requestId",
"path" : "TestScript.setup.action.operation.requestId",
"short" : "Fixture Id of mapped request",
"definition" : "The fixture id (maybe new) to map to the request.",
"comment" : "If a requestId is supplied, then the resulting request (both headers and body) is mapped to the fixture ID (which may be entirely new and previously undeclared) designated by \"requestId\". If requestId is not specified, it is the test engine's responsibility to store the request and use it as the requestId in subsequent assertions when assertion path and/or headerField is specified, direction is equal to request, and the requestId in not specified.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "id"
}]
},
{
"id" : "TestScript.setup.action.operation.responseId",
"path" : "TestScript.setup.action.operation.responseId",
"short" : "Fixture Id of mapped response",
"definition" : "The fixture id (maybe new) to map to the response.",
"comment" : "If a responseId is supplied, and the server responds, then the resulting response (both headers and body) is mapped to the fixture ID (which may be entirely new and previously undeclared) designated by \"responseId\". If responseId is not specified, it is the test engine's responsibility to store the response and use it as the responseId in subsequent assertions when assertion path and/or headerField is specified and the responseId is not specified.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "id"
}]
},
{
"id" : "TestScript.setup.action.operation.sourceId",
"path" : "TestScript.setup.action.operation.sourceId",
"short" : "Fixture Id of body for PUT and POST requests",
"definition" : "The id of the fixture used as the body of a PUT or POST request.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "id"
}]
},
{
"id" : "TestScript.setup.action.operation.targetId",
"path" : "TestScript.setup.action.operation.targetId",
"short" : "Id of fixture used for extracting the [id], [type], and [vid] for GET requests",
"definition" : "Id of fixture used for extracting the [id], [type], and [vid] for GET requests.",
"comment" : "If \"url\" element is specified, then \"targetId\", \"params\", and \"resource\" elements will be ignored as \"url\" element will have everything needed for constructing the request url. If \"params\" element is specified, then \"targetId\" element is ignored. For FHIR operations that require a resource (e.g. \"read\" and \"vread\" operations), the \"resource\" element must be specified when \"params\" element is specified. If \"url\" and \"params\" elements are absent, then the request url will be constructed from \"targetId\" fixture if present. For \"read\" operation, the resource and id values will be extracted from \"targetId\" fixture and used to construct the url. For \"vread\" and \"history\" operations, the versionId value will also be used.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "id"
}]
},
{
"id" : "TestScript.setup.action.operation.url",
"path" : "TestScript.setup.action.operation.url",
"short" : "Request URL",
"definition" : "Complete request URL.",
"comment" : "Used to set the request URL explicitly. If \"url\" element is defined, then \"targetId\", \"resource\", and \"params\" elements will be ignored. Test engines would use whatever is specified in \"url\" without tampering with the string (beyond encoding the URL for HTTP). Test engines do have to look for placeholders (${}) and replace the variable placeholders with the variable values at runtime before sending the request.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}]
},
{
"id" : "TestScript.setup.action.assert",
"path" : "TestScript.setup.action.assert",
"short" : "The assertion to perform",
"definition" : "Evaluates the results of previous operations to determine if the server under test behaves appropriately.",
"comment" : "In order to evaluate an assertion, the request, response, and results of the most recently executed operation must always be maintained by the test engine.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "tst-12",
"severity" : "error",
"human" : "Setup action assert response and responseCode SHALL be empty when direction equals request",
"expression" : "(response.empty() and responseCode.empty() and direction = 'request') or direction.empty() or direction = 'response'",
"xpath" : "((count(f:response) + count(f:responseCode)) = 0 and (f:direction/@value='request')) or (count(f:direction) = 0) or (f:direction/@value='response')"
},
{
"key" : "tst-5",
"severity" : "error",
"human" : "Only a single assertion SHALL be present within setup action assert element.",
"expression" : "extension.exists() or (contentType.count() + expression.count() + headerField.count() + minimumId.count() + navigationLinks.count() + path.count() + requestMethod.count() + resource.count() + responseCode.count() + response.count() + validateProfileId.count() <=1)",
"xpath" : "count(f:contentType) + count(f:expression) + count(f:headerField) + count(f:minimumId) + count(f:navigationLinks) + count(f:path) + count(f:requestMethod) + count(f:resource) + count(f:responseCode) + count(f:response) + count(f:rule) + count(f:ruleset) + count(f:validateProfileId) <=1"
},
{
"key" : "tst-10",
"severity" : "error",
"human" : "Setup action assert SHALL contain either compareToSourceId and compareToSourceExpression, compareToSourceId and compareToSourcePath or neither.",
"expression" : "compareToSourceId.empty() xor (compareToSourceExpression.exists() or compareToSourcePath.exists())",
"xpath" : "(f:compareToSourceId and f:compareToSourceExpression) or (f:compareToSourceId and f:compareToSourcePath) or not(f:compareToSourceId or f:compareToSourceExpression or f:compareToSourcePath)"
}]
},
{
"id" : "TestScript.setup.action.assert.label",
"path" : "TestScript.setup.action.assert.label",
"short" : "Tracking/logging assertion label",
"definition" : "The label would be used for tracking/logging purposes by test engines.",
"comment" : "This has no impact on the verification itself.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}]
},
{
"id" : "TestScript.setup.action.assert.description",
"path" : "TestScript.setup.action.assert.description",
"short" : "Tracking/reporting assertion description",
"definition" : "The description would be used by test engines for tracking and reporting purposes.",
"comment" : "This has no impact on the verification itself.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}]
},
{
"id" : "TestScript.setup.action.assert.direction",
"path" : "TestScript.setup.action.assert.direction",
"short" : "response | request",
"definition" : "The direction to use for the assertion.",
"comment" : "If the direction is specified as \"response\" (the default), then the processing of this assert is against the received response message. If the direction is specified as \"request\", then the processing of this assert is against the sent request message.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "code"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AssertionDirectionType"
}],
"strength" : "required",
"description" : "The type of direction to use for assertion.",
"valueSet" : "http://hl7.org/fhir/ValueSet/assert-direction-codes|4.0.1"
}
},
{
"id" : "TestScript.setup.action.assert.compareToSourceId",
"path" : "TestScript.setup.action.assert.compareToSourceId",
"short" : "Id of the source fixture to be evaluated",
"definition" : "Id of the source fixture used as the contents to be evaluated by either the \"source/expression\" or \"sourceId/path\" definition.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}]
},
{
"id" : "TestScript.setup.action.assert.compareToSourceExpression",
"path" : "TestScript.setup.action.assert.compareToSourceExpression",
"short" : "The FHIRPath expression to evaluate against the source fixture",
"definition" : "The FHIRPath expression to evaluate against the source fixture. When compareToSourceId is defined, either compareToSourceExpression or compareToSourcePath must be defined, but not both.",
"comment" : "Thefhirpath expression to be evaluated against the expected fixture to compare to. Ignored if \"assert.value\" is used. The evaluation will be done before the assertion is evaluated.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}]
},
{
"id" : "TestScript.setup.action.assert.compareToSourcePath",
"path" : "TestScript.setup.action.assert.compareToSourcePath",
"short" : "XPath or JSONPath expression to evaluate against the source fixture",
"definition" : "XPath or JSONPath expression to evaluate against the source fixture. When compareToSourceId is defined, either compareToSourceExpression or compareToSourcePath must be defined, but not both.",
"comment" : "The XPath or JSONPath expression to be evaluated against the expected fixture to compare to. Ignored if \"assert.value\" is used. The evaluation will be done before the assertion is evaluated.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}]
},
{
"id" : "TestScript.setup.action.assert.contentType",
"path" : "TestScript.setup.action.assert.contentType",
"short" : "Mime type to compare against the 'Content-Type' header",
"definition" : "The mime-type contents to compare against the request or response message 'Content-Type' header.",
"comment" : "If this is specified, then test engine shall confirm that the content-type of the last operation's headers is set to this value. If \"assert.sourceId\" element is specified, then the evaluation will be done against the headers mapped to that sourceId (and not the last operation's headers). If you'd like to have more control over the string, then use 'assert.headerField' instead.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "code"
}],
"example" : [{
"label" : "General",
"valueCode" : "application/fhir+xml"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MimeType"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "The mime type of an attachment. Any valid mime type is allowed.",
"valueSet" : "http://hl7.org/fhir/ValueSet/mimetypes|4.0.1"
}
},
{
"id" : "TestScript.setup.action.assert.expression",
"path" : "TestScript.setup.action.assert.expression",
"short" : "The FHIRPath expression to be evaluated",
"definition" : "The FHIRPath expression to be evaluated against the request or response message contents - HTTP headers and payload.",
"comment" : "If both \"expression\" and a \"fixtureId\" are specified, then the expression will be evaluated against the request or response body mapped to the fixtureId. If \"expression\" is specified and a \"fixtureId\" is not, then the expression will be evaluated against the response body of the last operation. Test engines are to store the request and response body and headers of the last operation at all times for subsequent assertions.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}]
},
{
"id" : "TestScript.setup.action.assert.headerField",
"path" : "TestScript.setup.action.assert.headerField",
"short" : "HTTP header field name",
"definition" : "The HTTP header field name e.g. 'Location'.",
"comment" : "If \"headerField\" is specified then \"value\" must be specified. If \"sourceId\" is not specified, then \"headerField\" will be evaluated against the last operation's response headers. Test engines are to keep track of the last operation's response body and response headers.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}]
},
{
"id" : "TestScript.setup.action.assert.minimumId",
"path" : "TestScript.setup.action.assert.minimumId",
"short" : "Fixture Id of minimum content resource",
"definition" : "The ID of a fixture. Asserts that the response contains at a minimum the fixture specified by minimumId.",
"comment" : "Asserts that the response contains all the element/content in another fixture pointed to by minimumId. This can be a statically defined fixture or one that is dynamically set via responseId.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}]
},
{
"id" : "TestScript.setup.action.assert.navigationLinks",
"path" : "TestScript.setup.action.assert.navigationLinks",
"short" : "Perform validation on navigation links?",
"definition" : "Whether or not the test execution performs validation on the bundle navigation links.",
"comment" : "Asserts that the Bundle contains first, last, and next links.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "boolean"
}]
},
{
"id" : "TestScript.setup.action.assert.operator",
"path" : "TestScript.setup.action.assert.operator",
"short" : "equals | notEquals | in | notIn | greaterThan | lessThan | empty | notEmpty | contains | notContains | eval",
"definition" : "The operator type defines the conditional behavior of the assert. If not defined, the default is equals.",
"comment" : "Operators are useful especially for negative testing. If operator is not specified, then the \"equals\" operator is assumed; e.g. ``` ```.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "code"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AssertionOperatorType"
}],
"strength" : "required",
"description" : "The type of operator to use for assertion.",
"valueSet" : "http://hl7.org/fhir/ValueSet/assert-operator-codes|4.0.1"
}
},
{
"id" : "TestScript.setup.action.assert.path",
"path" : "TestScript.setup.action.assert.path",
"short" : "XPath or JSONPath expression",
"definition" : "The XPath or JSONPath expression to be evaluated against the fixture representing the response received from server.",
"comment" : "If both \"path\" and a \"fixtureId\" are specified, then the path will be evaluated against the request or response body mapped to the fixtureId. If \"path\" is specified and a \"fixtureId\" is not, then the path will be evaluated against the response body of the last operation. Test engines are to store the request and response body and headers of the last operation at all times for subsequent assertions.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}]
},
{
"id" : "TestScript.setup.action.assert.requestMethod",
"path" : "TestScript.setup.action.assert.requestMethod",
"short" : "delete | get | options | patch | post | put | head",
"definition" : "The request method or HTTP operation code to compare against that used by the client system under test.",
"comment" : "If \"requestMethod\" is specified then it will be used in place of \"value\". The \"requestMethod\" will evaluate against the last operation's request HTTP operation.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "code"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "TestScriptRequestMethodCode"
}],
"strength" : "required",
"description" : "The allowable request method or HTTP operation codes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/http-operations|4.0.1"
}
},
{
"id" : "TestScript.setup.action.assert.requestURL",
"path" : "TestScript.setup.action.assert.requestURL",
"short" : "Request URL comparison value",
"definition" : "The value to use in a comparison against the request URL path string.",
"comment" : "If \"requestURL\" is specified then it will be used in place of \"value\". The \"requestURL\" will evaluate against the last operation's full request URL path string.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}]
},
{
"id" : "TestScript.setup.action.assert.resource",
"path" : "TestScript.setup.action.assert.resource",
"short" : "Resource type",
"definition" : "The type of the resource. See http://build.fhir.org/resourcelist.html.",
"comment" : "This will be expected resource type in response body e.g. in read, vread, search, etc. See http://build.fhir.org/resourcelist.html for complete list of resource types; e.g. .",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "code"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "FHIRDefinedType"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "A list of all the concrete types defined in this version of the FHIR specification - Data Types and Resource Types.",
"valueSet" : "http://hl7.org/fhir/ValueSet/defined-types|4.0.1"
}
},
{
"id" : "TestScript.setup.action.assert.response",
"path" : "TestScript.setup.action.assert.response",
"short" : "okay | created | noContent | notModified | bad | forbidden | notFound | methodNotAllowed | conflict | gone | preconditionFailed | unprocessable",
"definition" : "okay | created | noContent | notModified | bad | forbidden | notFound | methodNotAllowed | conflict | gone | preconditionFailed | unprocessable.",
"comment" : "This is a shorter way of achieving similar verifications via \"assert.responseCode\". If you need more control, then use \"assert.responseCode\" e.g. .",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "code"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AssertionResponseTypes"
}],
"strength" : "required",
"description" : "The type of response code to use for assertion.",
"valueSet" : "http://hl7.org/fhir/ValueSet/assert-response-code-types|4.0.1"
}
},
{
"id" : "TestScript.setup.action.assert.responseCode",
"path" : "TestScript.setup.action.assert.responseCode",
"short" : "HTTP response code to test",
"definition" : "The value of the HTTP response code to be tested.",
"comment" : "To be used with \"operator\" attribute value. Asserts that the response code equals this value if \"operator\" is not specified. If the operator is \"in\" or \"notIn\" then the responseCode would be a comma-separated list of values e.g. \"200,201\". Otherwise, it's expected to be a numeric value. If \"fixture\" is not specified, then the \"responseBodyId\" value of the last operation is assumed.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}]
},
{
"id" : "TestScript.setup.action.assert.sourceId",
"path" : "TestScript.setup.action.assert.sourceId",
"short" : "Fixture Id of source expression or headerField",
"definition" : "Fixture to evaluate the XPath/JSONPath expression or the headerField against.",
"comment" : "This can be a statically defined fixture (at the top of the testscript) or a dynamically set fixture created by responseId of the action.operation element.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "id"
}]
},
{
"id" : "TestScript.setup.action.assert.validateProfileId",
"path" : "TestScript.setup.action.assert.validateProfileId",
"short" : "Profile Id of validation profile reference",
"definition" : "The ID of the Profile to validate against.",
"comment" : "The ID of a Profile fixture. Asserts that the response is valid according to the Profile specified by validateProfileId.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "id"
}]
},
{
"id" : "TestScript.setup.action.assert.value",
"path" : "TestScript.setup.action.assert.value",
"short" : "The value to compare to",
"definition" : "The value to compare to.",
"comment" : "The string-representation of a number, string, or boolean that is expected. Test engines do have to look for placeholders (${}) and replace the variable placeholders with the variable values at runtime before comparing this value to the actual value.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}]
},
{
"id" : "TestScript.setup.action.assert.warningOnly",
"path" : "TestScript.setup.action.assert.warningOnly",
"short" : "Will this assert produce a warning only on error?",
"definition" : "Whether or not the test execution will produce a warning only on error for this assert.",
"comment" : "If this element is specified and it is true, then assertion failures can be logged by test engine but should not stop the test script execution from proceeding. There are likely cases where the spec is not clear on what should happen. If the spec says something is optional (maybe a response header for example), but a server doesn’t do it, we could choose to issue a warning.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "boolean"
}]
},
{
"id" : "TestScript.test",
"path" : "TestScript.test",
"short" : "A test in this script",
"definition" : "A test in this script.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "TestScript.test.name",
"path" : "TestScript.test.name",
"short" : "Tracking/logging name of this test",
"definition" : "The name of this test used for tracking/logging purposes by test engines.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}]
},
{
"id" : "TestScript.test.description",
"path" : "TestScript.test.description",
"short" : "Tracking/reporting short description of the test",
"definition" : "A short description of the test used by test engines for tracking and reporting purposes.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}]
},
{
"id" : "TestScript.test.action",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "TestAction"
}],
"path" : "TestScript.test.action",
"short" : "A test operation or assert to perform",
"definition" : "Action would contain either an operation or an assertion.",
"comment" : "An action should contain either an operation or an assertion but not both. It can contain any number of variables.",
"min" : 1,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "tst-2",
"severity" : "error",
"human" : "Test action SHALL contain either an operation or assert but not both.",
"expression" : "operation.exists() xor assert.exists()",
"xpath" : "(f:operation or f:assert) and not(f:operation and f:assert)"
}]
},
{
"id" : "TestScript.test.action.operation",
"path" : "TestScript.test.action.operation",
"short" : "The setup operation to perform",
"definition" : "An operation would involve a REST request to a server.",
"min" : 0,
"max" : "1",
"contentReference" : "#TestScript.setup.action.operation",
"constraint" : [{
"key" : "tst-8",
"severity" : "error",
"human" : "Test operation SHALL contain either sourceId or targetId or params or url.",
"expression" : "sourceId.exists() or (targetId.count() + url.count() + params.count() = 1) or (type.code in ('capabilities' | 'search' | 'transaction' | 'history'))",
"xpath" : "f:sourceId or (f:targetId or f:url or f:params) and (count(f:targetId) + count(f:url) + count(f:params) =1) or (f:type/f:code/@value='capabilities' or f:type/f:code/@value='search' or f:type/f:code/@value='transaction' or f:type/f:code/@value='history')"
}]
},
{
"id" : "TestScript.test.action.assert",
"path" : "TestScript.test.action.assert",
"short" : "The setup assertion to perform",
"definition" : "Evaluates the results of previous operations to determine if the server under test behaves appropriately.",
"comment" : "In order to evaluate an assertion, the request, response, and results of the most recently executed operation must always be maintained by the test engine.",
"min" : 0,
"max" : "1",
"contentReference" : "#TestScript.setup.action.assert",
"constraint" : [{
"key" : "tst-11",
"severity" : "error",
"human" : "Test action assert SHALL contain either compareToSourceId and compareToSourceExpression, compareToSourceId and compareToSourcePath or neither.",
"expression" : "compareToSourceId.empty() xor (compareToSourceExpression.exists() or compareToSourcePath.exists())",
"xpath" : "(f:compareToSourceId and f:compareToSourceExpression) or (f:compareToSourceId and f:compareToSourcePath) or not(f:compareToSourceId or f:compareToSourceExpression or f:compareToSourcePath)"
},
{
"key" : "tst-13",
"severity" : "error",
"human" : "Test action assert response and response and responseCode SHALL be empty when direction equals request",
"expression" : "(response.empty() and responseCode.empty() and direction = 'request') or direction.empty() or direction = 'response'",
"xpath" : "((count(f:response) + count(f:responseCode)) = 0 and (f:direction/@value='request')) or (count(f:direction) = 0) or (f:direction/@value='response')"
},
{
"key" : "tst-6",
"severity" : "error",
"human" : "Only a single assertion SHALL be present within test action assert element.",
"expression" : "extension.exists() or (contentType.count() + expression.count() + headerField.count() + minimumId.count() + navigationLinks.count() + path.count() + requestMethod.count() + resource.count() + responseCode.count() + response.count() + validateProfileId.count() <=1)",
"xpath" : "count(f:contentType) + count(f:expression) + count(f:headerField) + count(f:minimumId) + count(f:navigationLinks) + count(f:path) + count(f:requestMethod) + count(f:resource) + count(f:responseCode) + count(f:response) + count(f:rule) + count(f:ruleset) + count(f:validateProfileId) <=1"
}]
},
{
"id" : "TestScript.teardown",
"path" : "TestScript.teardown",
"short" : "A series of required clean up steps",
"definition" : "A series of operations required to clean up after all the tests are executed (successfully or otherwise).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "TestScript.teardown.action",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "TeardownAction"
}],
"path" : "TestScript.teardown.action",
"short" : "One or more teardown operations to perform",
"definition" : "The teardown action will only contain an operation.",
"comment" : "An action should contain either an operation or an assertion but not both. It can contain any number of variables.",
"min" : 1,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "TestScript.teardown.action.operation",
"path" : "TestScript.teardown.action.operation",
"short" : "The teardown operation to perform",
"definition" : "An operation would involve a REST request to a server.",
"min" : 1,
"max" : "1",
"contentReference" : "#TestScript.setup.action.operation",
"constraint" : [{
"key" : "tst-9",
"severity" : "error",
"human" : "Teardown operation SHALL contain either sourceId or targetId or params or url.",
"expression" : "sourceId.exists() or (targetId.count() + url.count() + params.count() = 1) or (type.code in ('capabilities' | 'search' | 'transaction' | 'history'))",
"xpath" : "f:sourceId or (f:targetId or f:url or (f:params and f:resource)) and (count(f:targetId) + count(f:url) + count(f:params) =1) or (f:type/f:code/@value='capabilities' or f:type/f:code/@value='search' or f:type/f:code/@value='transaction' or f:type/f:code/@value='history')"
}]
}]
}
}
},
{
"fullUrl" : "http://hl7.org/fhir/StructureDefinition/ValueSet",
"resource" : {
"resourceType" : "StructureDefinition",
"id" : "ValueSet",
"meta" : {
"lastUpdated" : "2019-11-01T09:29:23.356+11:00"
},
"text" : {
"status" : "generated",
"div" : "Name Flags Card. Type Description & Constraints ValueSet IN 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 url Σ 0..1 uri Canonical identifier for this value set, represented as a URI (globally unique) identifier Σ 0..* Identifier Additional identifier for the value set (business identifier)
version Σ 0..1 string Business version of the value set name ΣI 0..1 string Name for this value set (computer friendly) title Σ 0..1 string Name for this value set (human friendly) status ?!Σ 1..1 code draft | active | retired | unknown
PublicationStatus (Required) experimental Σ 0..1 boolean For testing purposes, not real usage date Σ 0..1 dateTime Date last changed publisher Σ 0..1 string Name of the publisher (organization or individual) contact Σ 0..* ContactDetail Contact details for the publisher
description 0..1 markdown Natural language description of the value set useContext ΣTU 0..* UsageContext The context that the content is intended to support
jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for value set (if applicable)
Jurisdiction (Extensible)
immutable Σ 0..1 boolean Indicates whether or not any change to the content logical definition may occur purpose 0..1 markdown Why this value set is defined copyright 0..1 markdown Use and/or publishing restrictions compose 0..1 BackboneElement Content logical definition of the value set (CLD) lockedDate Σ 0..1 date Fixed date for references with no specified version (transitive) inactive Σ 0..1 boolean Whether inactive codes are in the value set include ΣI 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
system ΣI 0..1 uri The system the codes come from version Σ 0..1 string Specific version of the code system referred to concept I 0..* BackboneElement A concept defined in the system
code 1..1 code Code or expression from system display 0..1 string Text to display for this code for this value set in this valueset designation 0..* BackboneElement Additional representations for this concept
language 0..1 code Human language of the designation
Common Languages (Preferred but limited to AllLanguages) use 0..1 Coding Types of uses of designations
Designation Use (Extensible) value 1..1 string The text value for this designation filter ΣI 0..* BackboneElement Select codes/concepts by their properties (including relationships)
property Σ 1..1 code A property/filter defined by the code system op Σ 1..1 code = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists
FilterOperator (Required) value Σ 1..1 string Code from the system, or regex criteria, or boolean value for exists valueSet ΣI 0..* canonical(ValueSet) Select the contents included in this value set
exclude I 0..* see include Explicitly exclude codes from a code system or other value sets
expansion 0..1 BackboneElement Used when the value set is "expanded" identifier 0..1 uri Identifies the value set expansion (business identifier) timestamp 1..1 dateTime Time ValueSet expansion happened total 0..1 integer Total number of codes in the expansion offset 0..1 integer Offset at which this resource starts parameter 0..* BackboneElement Parameter that controlled the expansion process
name 1..1 string Name as assigned by the client or server value[x] 0..1 Value of the named parameter valueString string valueBoolean boolean valueInteger integer valueDecimal decimal valueUri uri valueCode code valueDateTime dateTime contains I 0..* BackboneElement Codes in the value set
+ Rule: SHALL have a code or a display
+ Rule: Must have a code if not abstract
+ Rule: Must have a system if a code is present
system 0..1 uri System value for the code abstract 0..1 boolean If user cannot select this entry inactive 0..1 boolean If concept is inactive in the code system version 0..1 string Version in which this code/display is defined code I 0..1 code Code - if blank, this is not a selectable code display I 0..1 string User display for the concept designation 0..* see designation Additional representations for this item
contains 0..* see contains Codes contained under this entry
Documentation for this format
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Foundation.Terminology"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "normative"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode" : "4.0.0"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 5
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "anonymous"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "vocab"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/ValueSet",
"version" : "4.0.1",
"name" : "ValueSet",
"status" : "active",
"date" : "2019-11-01T09:29:23+11:00",
"publisher" : "Health Level Seven International (Vocabulary)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/Vocab/index.cfm"
}]
}],
"description" : "A ValueSet resource instance specifies a set of codes drawn from one or more code systems, intended for use in a particular context. Value sets link between [[[CodeSystem]]] definitions and their use in [coded elements](terminologies.html).",
"fhirVersion" : "4.0.1",
"mapping" : [{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
},
{
"identity" : "workflow",
"uri" : "http://hl7.org/fhir/workflow",
"name" : "Workflow Pattern"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/fivews",
"name" : "FiveWs Pattern Mapping"
},
{
"identity" : "objimpl",
"uri" : "http://hl7.org/fhir/object-implementation",
"name" : "Object Implementation Information"
}],
"kind" : "resource",
"abstract" : false,
"type" : "ValueSet",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"_baseDefinition" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-codegen-super",
"valueString" : "MetadataResource"
}]
},
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "ValueSet",
"path" : "ValueSet",
"short" : "A set of codes drawn from one or more code systems",
"definition" : "A ValueSet resource instance specifies a set of codes drawn from one or more code systems, intended for use in a particular context. Value sets link between [CodeSystem](codesystem.html) definitions and their use in [coded elements](terminologies.html).",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ValueSet",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "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",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.`div`.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "vsd-0",
"severity" : "warning",
"human" : "Name should be usable as an identifier for the module by machine processing applications such as code generation",
"expression" : "name.matches('[A-Z]([A-Za-z0-9_]){0,254}')",
"xpath" : "not(exists(f:name/@value)) or matches(f:name/@value, '[A-Z]([A-Za-z0-9_]){0,254}')"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ValueSet.id",
"path" : "ValueSet.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "ValueSet.meta",
"path" : "ValueSet.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "ValueSet.implicitRules",
"path" : "ValueSet.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "ValueSet.language",
"path" : "ValueSet.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "ValueSet.text",
"path" : "ValueSet.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "ValueSet.contained",
"path" : "ValueSet.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ValueSet.extension",
"path" : "ValueSet.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ValueSet.modifierExtension",
"path" : "ValueSet.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ValueSet.url",
"path" : "ValueSet.url",
"short" : "Canonical identifier for this value set, represented as a URI (globally unique)",
"definition" : "An absolute URI that is used to identify this value set when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this value set is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the value set is stored on different servers.",
"comment" : "Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.\n\nThe determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions). \n\nIn some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.",
"requirements" : "Allows the value set to be referenced by a single globally unique identifier.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ValueSet.url",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.url"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ValueSet.identifier",
"path" : "ValueSet.identifier",
"short" : "Additional identifier for the value set (business identifier)",
"definition" : "A formal identifier that is used to identify this value set when it is represented in other formats, or referenced in a specification, model, design or an instance.",
"comment" : "Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this value set outside of FHIR, where it is not possible to use the logical URI.",
"requirements" : "Allows externally provided and/or usable business identifiers to be easily associated with the module.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ValueSet.identifier",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Identifier"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.identifier"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "ValueSet.version",
"path" : "ValueSet.version",
"short" : "Business version of the value set",
"definition" : "The identifier that is used to identify this version of the value set when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the value set author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.",
"comment" : "There may be different value set instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the value set with the format [url]|[version].",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ValueSet.version",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.version"
},
{
"identity" : "w5",
"map" : "FiveWs.version"
}]
},
{
"id" : "ValueSet.name",
"path" : "ValueSet.name",
"short" : "Name for this value set (computer friendly)",
"definition" : "A natural language name identifying the value set. This name should be usable as an identifier for the module by machine processing applications such as code generation.",
"comment" : "The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.A name should be provided unless the value set is a contained resource (e.g. an anonymous value set in a profile). Most registries will require a name.",
"requirements" : "Support human navigation and code generation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ValueSet.name",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"condition" : ["inv-0"],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "ValueSet.title",
"path" : "ValueSet.title",
"short" : "Name for this value set (human friendly)",
"definition" : "A short, descriptive, user-friendly title for the value set.",
"comment" : "This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ValueSet.title",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.title"
}]
},
{
"id" : "ValueSet.status",
"path" : "ValueSet.status",
"short" : "draft | active | retired | unknown",
"definition" : "The status of this value set. Enables tracking the life-cycle of the content. The status of the value set applies to the value set definition (ValueSet.compose) and the associated ValueSet metadata. Expansions do not have a state.",
"comment" : "Allows filtering of value sets that are appropriate for use versus not.See also the [valueset-workflowStatus](extension-valueset-workflowstatus.html) extension for additional status information related to the editorial process.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ValueSet.status",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This is labeled as \"Is Modifier\" because applications should not use a retired {{title}} without due consideration",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "PublicationStatus"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "The lifecycle status of an artifact.",
"valueSet" : "http://hl7.org/fhir/ValueSet/publication-status|4.0.1"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.status"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
}]
},
{
"id" : "ValueSet.experimental",
"path" : "ValueSet.experimental",
"short" : "For testing purposes, not real usage",
"definition" : "A Boolean value to indicate that this value set is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.",
"comment" : "Allows filtering of value sets that are appropriate for use versus not.",
"requirements" : "Enables experimental content to be developed following the same lifecycle that would be used for a production-level value set.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ValueSet.experimental",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.experimental"
},
{
"identity" : "w5",
"map" : "FiveWs.class"
}]
},
{
"id" : "ValueSet.date",
"path" : "ValueSet.date",
"short" : "Date last changed",
"definition" : "The date (and optionally time) when the value set was created or revised (e.g. the 'content logical definition').",
"comment" : "Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the value set. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.",
"alias" : ["Revision Date"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "ValueSet.date",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.date"
},
{
"identity" : "w5",
"map" : "FiveWs.recorded"
},
{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ValueSet.publisher",
"path" : "ValueSet.publisher",
"short" : "Name of the publisher (organization or individual)",
"definition" : "The name of the organization or individual that published the value set.",
"comment" : "Usually an organization but may be an individual. The publisher (or steward) of the value set is the organization or individual primarily responsible for the maintenance and upkeep of the value set. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the value set. This item SHOULD be populated unless the information is available from context.",
"requirements" : "Helps establish the \"authority/credibility\" of the value set. May also allow for contact.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ValueSet.publisher",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.publisher"
},
{
"identity" : "w5",
"map" : "FiveWs.witness"
}]
},
{
"id" : "ValueSet.contact",
"path" : "ValueSet.contact",
"short" : "Contact details for the publisher",
"definition" : "Contact details to assist a user in finding and communicating with the publisher.",
"comment" : "May be a web site, an email address, a telephone number, etc.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ValueSet.contact",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "ContactDetail"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.contact"
}]
},
{
"id" : "ValueSet.description",
"path" : "ValueSet.description",
"short" : "Natural language description of the value set",
"definition" : "A free text natural language description of the value set from a consumer's perspective. The textual description specifies the span of meanings for concepts to be included within the Value Set Expansion, and also may specify the intended use and limitations of the Value Set.",
"comment" : "This description can be used to capture details such as why the value set was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the value set as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the value set is presumed to be the predominant language in the place the value set was created).The description is not intended to describe the semantics of the Value Set - there are no intrinsic semantics separate from the codes contained in its expansion. The description should capture its intended use, which is needed for ensuring integrity for its use in models across future changes. A description should be provided unless the value set is a contained resource (e.g. an anonymous value set in a profile). Most registries will require a description.",
"alias" : ["Scope",
"Purpose"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "ValueSet.description",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "markdown"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.description"
},
{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ValueSet.useContext",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"path" : "ValueSet.useContext",
"short" : "The context that the content is intended to support",
"definition" : "The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate value set instances.",
"comment" : "When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.",
"requirements" : "Assist in searching for appropriate content.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ValueSet.useContext",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "UsageContext"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.useContext"
}]
},
{
"id" : "ValueSet.jurisdiction",
"path" : "ValueSet.jurisdiction",
"short" : "Intended jurisdiction for value set (if applicable)",
"definition" : "A legal or geographic region in which the value set is intended to be used.",
"comment" : "It may be possible for the value set to be used in jurisdictions other than those for which it was originally designed or intended.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ValueSet.jurisdiction",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Jurisdiction"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "extensible",
"description" : "Countries and regions within which this artifact is targeted for use.",
"valueSet" : "http://hl7.org/fhir/ValueSet/jurisdiction"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.jurisdiction"
}]
},
{
"id" : "ValueSet.immutable",
"path" : "ValueSet.immutable",
"short" : "Indicates whether or not any change to the content logical definition may occur",
"definition" : "If this is set to 'true', then no new versions of the content logical definition can be created. Note: Other metadata might still change.",
"comment" : "Normally immutability is set to 'false', which is the default assumption if it is not populated. Note that the implication is that if this is set to 'true', there may be only one ValueSet version for this definition. Immutability tends to be set to 'true' in one of two cases: - Where the value set, by the nature of its usage, cannot change. For example \"All specializations of ACT in ActClassCode\" - Where there's no safe way to express the \"Purpose\" such that someone else could safely make changes to the value set definition. Source workflow control must guarantee that the same URI always yields the same definition.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ValueSet.immutable",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "ValueSet.purpose",
"path" : "ValueSet.purpose",
"short" : "Why this value set is defined",
"definition" : "Explanation of why this value set is needed and why it has been designed as it has.",
"comment" : "This element does not describe the usage of the value set. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this value set.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ValueSet.purpose",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "markdown"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.purpose"
},
{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "ValueSet.copyright",
"path" : "ValueSet.copyright",
"short" : "Use and/or publishing restrictions",
"definition" : "A copyright statement relating to the value set and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the value set.",
"comment" : "nullFrequently, the copyright differs between the value set and the codes that are included. The copyright statement should clearly differentiate between these when required.",
"requirements" : "Consumers must be able to determine any legal restrictions on the use of the value set and/or its content.",
"alias" : ["License",
"Restrictions"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "ValueSet.copyright",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "markdown"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.copyright"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "ValueSet.compose",
"path" : "ValueSet.compose",
"short" : "Content logical definition of the value set (CLD)",
"definition" : "A set of criteria that define the contents of the value set by including or excluding codes selected from the specified code system(s) that the value set draws from. This is also known as the Content Logical Definition (CLD).",
"alias" : ["Content Logical Definition",
"CLD"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "ValueSet.compose",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ValueSet.compose.id",
"path" : "ValueSet.compose.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "ValueSet.compose.extension",
"path" : "ValueSet.compose.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "ValueSet.compose.modifierExtension",
"path" : "ValueSet.compose.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ValueSet.compose.lockedDate",
"path" : "ValueSet.compose.lockedDate",
"short" : "Fixed date for references with no specified version (transitive)",
"definition" : "The Locked Date is the effective date that is used to determine the version of all referenced Code Systems and Value Set Definitions included in the compose that are not already tied to a specific version.",
"comment" : "With a defined lockedDate the value set is considered \"Locked\". Otherwise, the value set may have different expansions as underlying code systems and/or value sets evolve. The interpretation of lockedDate is often dependent on the context - e.g. a SNOMED CT derived value set with a lockedDate will have a different expansion in USA than in UK. If a value set specifies a version for include and exclude statements, and also specifies a locked date, the specified versions need to be available that date, or the value set will not be usable.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ValueSet.compose.lockedDate",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "date"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.init"
}]
},
{
"id" : "ValueSet.compose.inactive",
"path" : "ValueSet.compose.inactive",
"short" : "Whether inactive codes are in the value set",
"definition" : "Whether inactive codes - codes that are not approved for current use - are in the value set. If inactive = true, inactive codes are to be included in the expansion, if inactive = false, the inactive codes will not be included in the expansion. If absent, the behavior is determined by the implementation, or by the applicable $expand parameters (but generally, inactive codes would be expected to be included).",
"comment" : "Note that in the FHIR terminology framework, \"deprecated\" does not mean inactive, but in some code systems, e.g. LOINC, \"deprecated\" does mean inactive. Code systems should define what codes are considered to be inactive. If this is not clearly defined (including in the FHIR code system resource), then all codes are assumed to be active.\n\nThe Value Set Definition specification defines an ActiveOnly element, which is the reverse of this element e.g. (ValueSet.compose.inactive=FALSE) is the same as (VSD.ActiveOnly=TRUE).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ValueSet.compose.inactive",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "ValueSet.compose.include",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "ConceptSet"
}],
"path" : "ValueSet.compose.include",
"short" : "Include one or more codes from a code system or other value set(s)",
"definition" : "Include one or more codes from a code system or other value set(s).",
"comment" : "All the conditions in an include must be true. If a system is listed, all the codes from the system are listed. If one or more filters are listed, all of the filters must apply. If one or more value sets are listed, the codes must be in all the value sets. E.g. each include is 'include all the codes that meet all these conditions'.",
"min" : 1,
"max" : "*",
"base" : {
"path" : "ValueSet.compose.include",
"min" : 1,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "vsd-1",
"severity" : "error",
"human" : "A value set include/exclude SHALL have a value set or a system",
"expression" : "valueSet.exists() or system.exists()",
"xpath" : "exists(f:valueSet) or exists(f:system)"
},
{
"key" : "vsd-2",
"severity" : "error",
"human" : "A value set with concepts or filters SHALL include a system",
"expression" : "(concept.exists() or filter.exists()) implies system.exists()",
"xpath" : "not(exists(f:concept) or exists(f:filter)) or exists(f:system)"
},
{
"key" : "vsd-3",
"severity" : "error",
"human" : "Cannot have both concept and filter",
"expression" : "concept.empty() or filter.empty()",
"xpath" : "not(exists(f:concept)) or not(exists(f:filter))"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ValueSet.compose.include.id",
"path" : "ValueSet.compose.include.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "ValueSet.compose.include.extension",
"path" : "ValueSet.compose.include.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "ValueSet.compose.include.modifierExtension",
"path" : "ValueSet.compose.include.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ValueSet.compose.include.system",
"path" : "ValueSet.compose.include.system",
"short" : "The system the codes come from",
"definition" : "An absolute URI which is the code system from which the selected codes come from.",
"comment" : "If there are no codes or filters, the entire code system is included. Note that the set of codes that are included may contain abstract codes. See ''Coding.system'' for further documentation about the correct value for the system element.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ValueSet.compose.include.system",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"condition" : ["vsd-1",
"vsd-2"],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ValueSet.compose.include.version",
"path" : "ValueSet.compose.include.version",
"short" : "Specific version of the code system referred to",
"definition" : "The version of the code system that the codes are selected from, or the special version '*' for all versions.",
"comment" : "This is used when selecting the descendants of a concept - they may change between versions. If no version is specified, then the exact contents of the value set might not be known until a context of use binds it to a particular version. The special value '*' means all versions; It is at server discretion regarding expansions and which versions must be supported.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ValueSet.compose.include.version",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ValueSet.compose.include.concept",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "ConceptReference"
}],
"path" : "ValueSet.compose.include.concept",
"short" : "A concept defined in the system",
"definition" : "Specifies a concept to be included or excluded.",
"comment" : "The list of concepts is considered ordered, though the order might not have any particular significance. Typically, the order of an expansion follows that defined in the compose element.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ValueSet.compose.include.concept",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"condition" : ["vsd-3"],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ValueSet.compose.include.concept.id",
"path" : "ValueSet.compose.include.concept.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "ValueSet.compose.include.concept.extension",
"path" : "ValueSet.compose.include.concept.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "ValueSet.compose.include.concept.modifierExtension",
"path" : "ValueSet.compose.include.concept.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ValueSet.compose.include.concept.code",
"path" : "ValueSet.compose.include.concept.code",
"short" : "Code or expression from system",
"definition" : "Specifies a code for the concept to be included or excluded.",
"comment" : "Expressions are allowed if defined by the underlying code system.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ValueSet.compose.include.concept.code",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ValueSet.compose.include.concept.display",
"path" : "ValueSet.compose.include.concept.display",
"short" : "Text to display for this code for this value set in this valueset",
"definition" : "The text to display to the user for this concept in the context of this valueset. If no display is provided, then applications using the value set use the display specified for the code by the system.",
"comment" : "The value set resource allows for an alternative display to be specified for when this concept is used in this particular value set. See notes in the value set narrative about the correct use of this element.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ValueSet.compose.include.concept.display",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ValueSet.compose.include.concept.designation",
"path" : "ValueSet.compose.include.concept.designation",
"short" : "Additional representations for this concept",
"definition" : "Additional representations for this concept when used in this value set - other languages, aliases, specialized purposes, used for particular purposes, etc.",
"comment" : "Concepts have both a ```display``` and an array of ```designation```. The display is equivalent to a special designation with an implied ```designation.use``` of \"primary code\" and a language equal to the [Resource Language](resource.html#language).",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ValueSet.compose.include.concept.designation",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ValueSet.compose.include.concept.designation.id",
"path" : "ValueSet.compose.include.concept.designation.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "ValueSet.compose.include.concept.designation.extension",
"path" : "ValueSet.compose.include.concept.designation.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "ValueSet.compose.include.concept.designation.modifierExtension",
"path" : "ValueSet.compose.include.concept.designation.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ValueSet.compose.include.concept.designation.language",
"path" : "ValueSet.compose.include.concept.designation.language",
"short" : "Human language of the designation",
"definition" : "The language this designation is defined for.",
"comment" : "In the absence of a language, the resource language applies.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ValueSet.compose.include.concept.designation.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "ValueSet.compose.include.concept.designation.use",
"path" : "ValueSet.compose.include.concept.designation.use",
"short" : "Types of uses of designations",
"definition" : "A code that represents types of uses of designations.",
"comment" : "If no use is provided, the designation can be assumed to be suitable for general display to a human user.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ValueSet.compose.include.concept.designation.use",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Coding"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ConceptDesignationUse"
}],
"strength" : "extensible",
"description" : "Details of how a designation would be used.",
"valueSet" : "http://hl7.org/fhir/ValueSet/designation-use"
}
},
{
"id" : "ValueSet.compose.include.concept.designation.value",
"path" : "ValueSet.compose.include.concept.designation.value",
"short" : "The text value for this designation",
"definition" : "The text value for this designation.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ValueSet.compose.include.concept.designation.value",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ValueSet.compose.include.filter",
"path" : "ValueSet.compose.include.filter",
"short" : "Select codes/concepts by their properties (including relationships)",
"definition" : "Select concepts by specify a matching criterion based on the properties (including relationships) defined by the system, or on filters defined by the system. If multiple filters are specified, they SHALL all be true.",
"comment" : "Selecting codes by specifying filters based on properties is only possible where the underlying code system defines appropriate properties. Note that in some cases, the underlying code system defines the logical concepts but not the literal codes for the concepts. In such cases, the literal definitions may be provided by a third party.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ValueSet.compose.include.filter",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"condition" : ["vsd-3"],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ValueSet.compose.include.filter.id",
"path" : "ValueSet.compose.include.filter.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "ValueSet.compose.include.filter.extension",
"path" : "ValueSet.compose.include.filter.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "ValueSet.compose.include.filter.modifierExtension",
"path" : "ValueSet.compose.include.filter.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ValueSet.compose.include.filter.property",
"path" : "ValueSet.compose.include.filter.property",
"short" : "A property/filter defined by the code system",
"definition" : "A code that identifies a property or a filter defined in the code system.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ValueSet.compose.include.filter.property",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ValueSet.compose.include.filter.op",
"path" : "ValueSet.compose.include.filter.op",
"short" : "= | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists",
"definition" : "The kind of operation to perform as a part of the filter criteria.",
"comment" : "In case filter.property represents a property of the system, the operation applies to the selected property. In case filter.property represents a filter of the system, the operation SHALL match one of the CodeSystem.filter.operator values.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ValueSet.compose.include.filter.op",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "FilterOperator"
}],
"strength" : "required",
"description" : "The kind of operation to perform as a part of a property based filter.",
"valueSet" : "http://hl7.org/fhir/ValueSet/filter-operator|4.0.1"
},
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ValueSet.compose.include.filter.value",
"path" : "ValueSet.compose.include.filter.value",
"short" : "Code from the system, or regex criteria, or boolean value for exists",
"definition" : "The match value may be either a code defined by the system, or a string value, which is a regex match on the literal string of the property value (if the filter represents a property defined in CodeSystem) or of the system filter value (if the filter represents a filter defined in CodeSystem) when the operation is 'regex', or one of the values (true and false), when the operation is 'exists'.",
"comment" : "Use regex matching with care - full regex matching on every SNOMED CT term is prohibitive, for example.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ValueSet.compose.include.filter.value",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ValueSet.compose.include.valueSet",
"path" : "ValueSet.compose.include.valueSet",
"short" : "Select the contents included in this value set",
"definition" : "Selects the concepts found in this value set (based on its value set definition). This is an absolute URI that is a reference to ValueSet.url. If multiple value sets are specified this includes the union of the contents of all of the referenced value sets.",
"comment" : "The value set URI is either a logical reference to a defined value set such as a [SNOMED CT reference set](snomedct.html#implicit), or a direct reference to a value set definition using ValueSet.url. The reference might not refer to an actual FHIR ValueSet resource; in this case, whatever is referred to is an implicit definition of a value set that needs to be clear about how versions are resolved.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ValueSet.compose.include.valueSet",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ValueSet"]
}],
"condition" : ["vsd-1"],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ValueSet.compose.exclude",
"path" : "ValueSet.compose.exclude",
"short" : "Explicitly exclude codes from a code system or other value sets",
"definition" : "Exclude one or more codes from the value set based on code system filters and/or other value sets.",
"comment" : "Usually this is used to selectively exclude codes that were included by subsumption in the inclusions. Any display names specified for the codes are ignored.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ValueSet.compose.exclude",
"min" : 0,
"max" : "*"
},
"contentReference" : "#ValueSet.compose.include",
"condition" : ["vsd-2"],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ValueSet.expansion",
"path" : "ValueSet.expansion",
"short" : "Used when the value set is \"expanded\"",
"definition" : "A value set can also be \"expanded\", where the value set is turned into a simple collection of enumerated codes. This element holds the expansion, if it has been performed.",
"comment" : "Expansion is performed to produce a collection of codes that are ready to use for data entry or validation. Value set expansions are always considered to be stateless - they are a record of the set of codes in the value set at a point in time under a given set of conditions, and are not subject to ongoing maintenance.\n\nExpansion.parameter is a simplified list of parameters - a subset of the features of the [Parameters](parameters.html) resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ValueSet.expansion",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ValueSet.expansion.id",
"path" : "ValueSet.expansion.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "ValueSet.expansion.extension",
"path" : "ValueSet.expansion.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "ValueSet.expansion.modifierExtension",
"path" : "ValueSet.expansion.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ValueSet.expansion.identifier",
"path" : "ValueSet.expansion.identifier",
"short" : "Identifies the value set expansion (business identifier)",
"definition" : "An identifier that uniquely identifies this expansion of the valueset, based on a unique combination of the provided parameters, the system default parameters, and the underlying system code system versions etc. Systems may re-use the same identifier as long as those factors remain the same, and the expansion is the same, but are not required to do so. This is a business identifier.",
"comment" : "Typically, this uri is a UUID (e.g. urn:uuid:8230ff20-c97a-4167-a59d-dc2cb9df16dd).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ValueSet.expansion.identifier",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ValueSet.expansion.timestamp",
"path" : "ValueSet.expansion.timestamp",
"short" : "Time ValueSet expansion happened",
"definition" : "The time at which the expansion was produced by the expanding system.",
"comment" : "This SHOULD be a fully populated instant, but in some circumstances, value sets are expanded by hand, and the expansion is published without that precision.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ValueSet.expansion.timestamp",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ValueSet.expansion.total",
"path" : "ValueSet.expansion.total",
"short" : "Total number of codes in the expansion",
"definition" : "The total number of concepts in the expansion. If the number of concept nodes in this resource is less than the stated number, then the server can return more using the offset parameter.",
"comment" : "Paging only applies to flat expansions.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ValueSet.expansion.total",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "integer"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ValueSet.expansion.offset",
"path" : "ValueSet.expansion.offset",
"short" : "Offset at which this resource starts",
"definition" : "If paging is being used, the offset at which this resource starts. I.e. this resource is a partial view into the expansion. If paging is not being used, this element SHALL NOT be present.",
"comment" : "Paging only applies to flat expansions. If a filter is applied, the count is the number of concepts that matched the filter, not the number of concepts in an unfiltered view of the expansion.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ValueSet.expansion.offset",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "integer"
}],
"meaningWhenMissing" : "Paging is not being used",
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ValueSet.expansion.parameter",
"path" : "ValueSet.expansion.parameter",
"short" : "Parameter that controlled the expansion process",
"definition" : "A parameter that controlled the expansion process. These parameters may be used by users of expanded value sets to check whether the expansion is suitable for a particular purpose, or to pick the correct expansion.",
"comment" : "The server decides which parameters to include here, but at a minimum, the list SHOULD include all of the parameters that affect the $expand operation. If the expansion will be persisted all of these parameters SHALL be included. If the codeSystem on the server has a specified version then this version SHALL be provided as a parameter in the expansion (note that not all code systems have a version).",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ValueSet.expansion.parameter",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ValueSet.expansion.parameter.id",
"path" : "ValueSet.expansion.parameter.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "ValueSet.expansion.parameter.extension",
"path" : "ValueSet.expansion.parameter.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "ValueSet.expansion.parameter.modifierExtension",
"path" : "ValueSet.expansion.parameter.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ValueSet.expansion.parameter.name",
"path" : "ValueSet.expansion.parameter.name",
"short" : "Name as assigned by the client or server",
"definition" : "Name of the input parameter to the $expand operation; may be a server-assigned name for additional default or other server-supplied parameters used to control the expansion process.",
"comment" : "The names are assigned at the discretion of the server.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ValueSet.expansion.parameter.name",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ValueSet.expansion.parameter.value[x]",
"path" : "ValueSet.expansion.parameter.value[x]",
"short" : "Value of the named parameter",
"definition" : "The value of the parameter.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ValueSet.expansion.parameter.value[x]",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
},
{
"code" : "boolean"
},
{
"code" : "integer"
},
{
"code" : "decimal"
},
{
"code" : "uri"
},
{
"code" : "code"
},
{
"code" : "dateTime"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ValueSet.expansion.contains",
"path" : "ValueSet.expansion.contains",
"short" : "Codes in the value set",
"definition" : "The codes that are contained in the value set expansion.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ValueSet.expansion.contains",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "vsd-6",
"severity" : "error",
"human" : "SHALL have a code or a display",
"expression" : "code.exists() or display.exists()",
"xpath" : "exists(f:code) or exists(f:display)"
},
{
"key" : "vsd-9",
"severity" : "error",
"human" : "Must have a code if not abstract",
"expression" : "code.exists() or abstract = true",
"xpath" : "exists(f:code) or (f:abstract/@value = true())"
},
{
"key" : "vsd-10",
"severity" : "error",
"human" : "Must have a system if a code is present",
"expression" : "code.empty() or system.exists()",
"xpath" : "exists(f:system) or not(exists(f:code))"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ValueSet.expansion.contains.id",
"path" : "ValueSet.expansion.contains.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "ValueSet.expansion.contains.extension",
"path" : "ValueSet.expansion.contains.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "ValueSet.expansion.contains.modifierExtension",
"path" : "ValueSet.expansion.contains.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ValueSet.expansion.contains.system",
"path" : "ValueSet.expansion.contains.system",
"short" : "System value for the code",
"definition" : "An absolute URI which is the code system in which the code for this item in the expansion is defined.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ValueSet.expansion.contains.system",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ValueSet.expansion.contains.abstract",
"path" : "ValueSet.expansion.contains.abstract",
"short" : "If user cannot select this entry",
"definition" : "If true, this entry is included in the expansion for navigational purposes, and the user cannot select the code directly as a proper value.",
"comment" : "This should not be understood to exclude its use for searching (e.g. by subsumption testing). The client should know whether it is appropriate for the user to select an abstract code or not.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ValueSet.expansion.contains.abstract",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"meaningWhenMissing" : "If this is not populated, systems can assume that the concept it not abstract. This SHALL always be populated for abstract concepts",
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ValueSet.expansion.contains.inactive",
"path" : "ValueSet.expansion.contains.inactive",
"short" : "If concept is inactive in the code system",
"definition" : "If the concept is inactive in the code system that defines it. Inactive codes are those that are no longer to be used, but are maintained by the code system for understanding legacy data. It might not be known or specified whether an concept is inactive (and it may depend on the context of use).",
"comment" : "This should only have a value if the concept is inactive.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ValueSet.expansion.contains.inactive",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ValueSet.expansion.contains.version",
"path" : "ValueSet.expansion.contains.version",
"short" : "Version in which this code/display is defined",
"definition" : "The version of the code system from this code was taken. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.",
"comment" : "The exact value of the version string is specified by the system from which the code is derived.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ValueSet.expansion.contains.version",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ValueSet.expansion.contains.code",
"path" : "ValueSet.expansion.contains.code",
"short" : "Code - if blank, this is not a selectable code",
"definition" : "The code for this item in the expansion hierarchy. If this code is missing the entry in the hierarchy is a place holder (abstract) and does not represent a valid code in the value set.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ValueSet.expansion.contains.code",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"condition" : ["vsd-6"],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ValueSet.expansion.contains.display",
"path" : "ValueSet.expansion.contains.display",
"short" : "User display for the concept",
"definition" : "The recommended display for this item in the expansion.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ValueSet.expansion.contains.display",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"condition" : ["vsd-6"],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ValueSet.expansion.contains.designation",
"path" : "ValueSet.expansion.contains.designation",
"short" : "Additional representations for this item",
"definition" : "Additional representations for this item - other languages, aliases, specialized purposes, used for particular purposes, etc. These are relevant when the conditions of the expansion do not fix to a single correct representation.",
"comment" : "The designations provided must be based on the value set and code system definitions.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ValueSet.expansion.contains.designation",
"min" : 0,
"max" : "*"
},
"contentReference" : "#ValueSet.compose.include.concept.designation",
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "ValueSet.expansion.contains.contains",
"path" : "ValueSet.expansion.contains.contains",
"short" : "Codes contained under this entry",
"definition" : "Other codes and entries contained under this entry in the hierarchy.",
"comment" : "If the expansion uses this element, there is no implication about the logical relationship between them, and the structure cannot be used for logical inferencing. The structure exists to provide navigational assistance for helping human users to locate codes in the expansion.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ValueSet.expansion.contains.contains",
"min" : 0,
"max" : "*"
},
"contentReference" : "#ValueSet.expansion.contains",
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
}]
},
"differential" : {
"element" : [{
"id" : "ValueSet",
"path" : "ValueSet",
"short" : "A set of codes drawn from one or more code systems",
"definition" : "A ValueSet resource instance specifies a set of codes drawn from one or more code systems, intended for use in a particular context. Value sets link between [CodeSystem](codesystem.html) definitions and their use in [coded elements](terminologies.html).",
"min" : 0,
"max" : "*",
"constraint" : [{
"key" : "vsd-0",
"severity" : "warning",
"human" : "Name should be usable as an identifier for the module by machine processing applications such as code generation",
"expression" : "name.matches('[A-Z]([A-Za-z0-9_]){0,254}')",
"xpath" : "not(exists(f:name/@value)) or matches(f:name/@value, '[A-Z]([A-Za-z0-9_]){0,254}')"
}],
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ValueSet.url",
"path" : "ValueSet.url",
"short" : "Canonical identifier for this value set, represented as a URI (globally unique)",
"definition" : "An absolute URI that is used to identify this value set when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this value set is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the value set is stored on different servers.",
"comment" : "Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.\n\nThe determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions). \n\nIn some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.",
"requirements" : "Allows the value set to be referenced by a single globally unique identifier.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "uri"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.url"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ValueSet.identifier",
"path" : "ValueSet.identifier",
"short" : "Additional identifier for the value set (business identifier)",
"definition" : "A formal identifier that is used to identify this value set when it is represented in other formats, or referenced in a specification, model, design or an instance.",
"comment" : "Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this value set outside of FHIR, where it is not possible to use the logical URI.",
"requirements" : "Allows externally provided and/or usable business identifiers to be easily associated with the module.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Identifier"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.identifier"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "ValueSet.version",
"path" : "ValueSet.version",
"short" : "Business version of the value set",
"definition" : "The identifier that is used to identify this version of the value set when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the value set author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.",
"comment" : "There may be different value set instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the value set with the format [url]|[version].",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.version"
},
{
"identity" : "w5",
"map" : "FiveWs.version"
}]
},
{
"id" : "ValueSet.name",
"path" : "ValueSet.name",
"short" : "Name for this value set (computer friendly)",
"definition" : "A natural language name identifying the value set. This name should be usable as an identifier for the module by machine processing applications such as code generation.",
"comment" : "The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.A name should be provided unless the value set is a contained resource (e.g. an anonymous value set in a profile). Most registries will require a name.",
"requirements" : "Support human navigation and code generation.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"condition" : ["inv-0"],
"isSummary" : true
},
{
"id" : "ValueSet.title",
"path" : "ValueSet.title",
"short" : "Name for this value set (human friendly)",
"definition" : "A short, descriptive, user-friendly title for the value set.",
"comment" : "This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.title"
}]
},
{
"id" : "ValueSet.status",
"path" : "ValueSet.status",
"short" : "draft | active | retired | unknown",
"definition" : "The status of this value set. Enables tracking the life-cycle of the content. The status of the value set applies to the value set definition (ValueSet.compose) and the associated ValueSet metadata. Expansions do not have a state.",
"comment" : "Allows filtering of value sets that are appropriate for use versus not.See also the [valueset-workflowStatus](extension-valueset-workflowstatus.html) extension for additional status information related to the editorial process.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isModifier" : true,
"isModifierReason" : "This is labeled as \"Is Modifier\" because applications should not use a retired {{title}} without due consideration",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "PublicationStatus"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "The lifecycle status of an artifact.",
"valueSet" : "http://hl7.org/fhir/ValueSet/publication-status|4.0.1"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.status"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
}]
},
{
"id" : "ValueSet.experimental",
"path" : "ValueSet.experimental",
"short" : "For testing purposes, not real usage",
"definition" : "A Boolean value to indicate that this value set is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.",
"comment" : "Allows filtering of value sets that are appropriate for use versus not.",
"requirements" : "Enables experimental content to be developed following the same lifecycle that would be used for a production-level value set.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "boolean"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.experimental"
},
{
"identity" : "w5",
"map" : "FiveWs.class"
}]
},
{
"id" : "ValueSet.date",
"path" : "ValueSet.date",
"short" : "Date last changed",
"definition" : "The date (and optionally time) when the value set was created or revised (e.g. the 'content logical definition').",
"comment" : "Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the value set. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.",
"alias" : ["Revision Date"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "dateTime"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.date"
},
{
"identity" : "w5",
"map" : "FiveWs.recorded"
},
{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ValueSet.publisher",
"path" : "ValueSet.publisher",
"short" : "Name of the publisher (organization or individual)",
"definition" : "The name of the organization or individual that published the value set.",
"comment" : "Usually an organization but may be an individual. The publisher (or steward) of the value set is the organization or individual primarily responsible for the maintenance and upkeep of the value set. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the value set. This item SHOULD be populated unless the information is available from context.",
"requirements" : "Helps establish the \"authority/credibility\" of the value set. May also allow for contact.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.publisher"
},
{
"identity" : "w5",
"map" : "FiveWs.witness"
}]
},
{
"id" : "ValueSet.contact",
"path" : "ValueSet.contact",
"short" : "Contact details for the publisher",
"definition" : "Contact details to assist a user in finding and communicating with the publisher.",
"comment" : "May be a web site, an email address, a telephone number, etc.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "ContactDetail"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.contact"
}]
},
{
"id" : "ValueSet.description",
"path" : "ValueSet.description",
"short" : "Natural language description of the value set",
"definition" : "A free text natural language description of the value set from a consumer's perspective. The textual description specifies the span of meanings for concepts to be included within the Value Set Expansion, and also may specify the intended use and limitations of the Value Set.",
"comment" : "This description can be used to capture details such as why the value set was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the value set as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the value set is presumed to be the predominant language in the place the value set was created).The description is not intended to describe the semantics of the Value Set - there are no intrinsic semantics separate from the codes contained in its expansion. The description should capture its intended use, which is needed for ensuring integrity for its use in models across future changes. A description should be provided unless the value set is a contained resource (e.g. an anonymous value set in a profile). Most registries will require a description.",
"alias" : ["Scope",
"Purpose"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "markdown"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.description"
},
{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ValueSet.useContext",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"path" : "ValueSet.useContext",
"short" : "The context that the content is intended to support",
"definition" : "The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate value set instances.",
"comment" : "When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.",
"requirements" : "Assist in searching for appropriate content.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "UsageContext"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.useContext"
}]
},
{
"id" : "ValueSet.jurisdiction",
"path" : "ValueSet.jurisdiction",
"short" : "Intended jurisdiction for value set (if applicable)",
"definition" : "A legal or geographic region in which the value set is intended to be used.",
"comment" : "It may be possible for the value set to be used in jurisdictions other than those for which it was originally designed or intended.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Jurisdiction"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "extensible",
"description" : "Countries and regions within which this artifact is targeted for use.",
"valueSet" : "http://hl7.org/fhir/ValueSet/jurisdiction"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.jurisdiction"
}]
},
{
"id" : "ValueSet.immutable",
"path" : "ValueSet.immutable",
"short" : "Indicates whether or not any change to the content logical definition may occur",
"definition" : "If this is set to 'true', then no new versions of the content logical definition can be created. Note: Other metadata might still change.",
"comment" : "Normally immutability is set to 'false', which is the default assumption if it is not populated. Note that the implication is that if this is set to 'true', there may be only one ValueSet version for this definition. Immutability tends to be set to 'true' in one of two cases: - Where the value set, by the nature of its usage, cannot change. For example \"All specializations of ACT in ActClassCode\" - Where there's no safe way to express the \"Purpose\" such that someone else could safely make changes to the value set definition. Source workflow control must guarantee that the same URI always yields the same definition.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "boolean"
}],
"isSummary" : true
},
{
"id" : "ValueSet.purpose",
"path" : "ValueSet.purpose",
"short" : "Why this value set is defined",
"definition" : "Explanation of why this value set is needed and why it has been designed as it has.",
"comment" : "This element does not describe the usage of the value set. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this value set.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "markdown"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.purpose"
},
{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "ValueSet.copyright",
"path" : "ValueSet.copyright",
"short" : "Use and/or publishing restrictions",
"definition" : "A copyright statement relating to the value set and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the value set.",
"comment" : "nullFrequently, the copyright differs between the value set and the codes that are included. The copyright statement should clearly differentiate between these when required.",
"requirements" : "Consumers must be able to determine any legal restrictions on the use of the value set and/or its content.",
"alias" : ["License",
"Restrictions"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "markdown"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.copyright"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "ValueSet.compose",
"path" : "ValueSet.compose",
"short" : "Content logical definition of the value set (CLD)",
"definition" : "A set of criteria that define the contents of the value set by including or excluding codes selected from the specified code system(s) that the value set draws from. This is also known as the Content Logical Definition (CLD).",
"alias" : ["Content Logical Definition",
"CLD"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "ValueSet.compose.lockedDate",
"path" : "ValueSet.compose.lockedDate",
"short" : "Fixed date for references with no specified version (transitive)",
"definition" : "The Locked Date is the effective date that is used to determine the version of all referenced Code Systems and Value Set Definitions included in the compose that are not already tied to a specific version.",
"comment" : "With a defined lockedDate the value set is considered \"Locked\". Otherwise, the value set may have different expansions as underlying code systems and/or value sets evolve. The interpretation of lockedDate is often dependent on the context - e.g. a SNOMED CT derived value set with a lockedDate will have a different expansion in USA than in UK. If a value set specifies a version for include and exclude statements, and also specifies a locked date, the specified versions need to be available that date, or the value set will not be usable.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "date"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.init"
}]
},
{
"id" : "ValueSet.compose.inactive",
"path" : "ValueSet.compose.inactive",
"short" : "Whether inactive codes are in the value set",
"definition" : "Whether inactive codes - codes that are not approved for current use - are in the value set. If inactive = true, inactive codes are to be included in the expansion, if inactive = false, the inactive codes will not be included in the expansion. If absent, the behavior is determined by the implementation, or by the applicable $expand parameters (but generally, inactive codes would be expected to be included).",
"comment" : "Note that in the FHIR terminology framework, \"deprecated\" does not mean inactive, but in some code systems, e.g. LOINC, \"deprecated\" does mean inactive. Code systems should define what codes are considered to be inactive. If this is not clearly defined (including in the FHIR code system resource), then all codes are assumed to be active.\n\nThe Value Set Definition specification defines an ActiveOnly element, which is the reverse of this element e.g. (ValueSet.compose.inactive=FALSE) is the same as (VSD.ActiveOnly=TRUE).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "boolean"
}],
"isSummary" : true
},
{
"id" : "ValueSet.compose.include",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "ConceptSet"
}],
"path" : "ValueSet.compose.include",
"short" : "Include one or more codes from a code system or other value set(s)",
"definition" : "Include one or more codes from a code system or other value set(s).",
"comment" : "All the conditions in an include must be true. If a system is listed, all the codes from the system are listed. If one or more filters are listed, all of the filters must apply. If one or more value sets are listed, the codes must be in all the value sets. E.g. each include is 'include all the codes that meet all these conditions'.",
"min" : 1,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "vsd-2",
"severity" : "error",
"human" : "A value set with concepts or filters SHALL include a system",
"expression" : "(concept.exists() or filter.exists()) implies system.exists()",
"xpath" : "not(exists(f:concept) or exists(f:filter)) or exists(f:system)"
},
{
"key" : "vsd-3",
"severity" : "error",
"human" : "Cannot have both concept and filter",
"expression" : "concept.empty() or filter.empty()",
"xpath" : "not(exists(f:concept)) or not(exists(f:filter))"
},
{
"key" : "vsd-1",
"severity" : "error",
"human" : "A value set include/exclude SHALL have a value set or a system",
"expression" : "valueSet.exists() or system.exists()",
"xpath" : "exists(f:valueSet) or exists(f:system)"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ValueSet.compose.include.system",
"path" : "ValueSet.compose.include.system",
"short" : "The system the codes come from",
"definition" : "An absolute URI which is the code system from which the selected codes come from.",
"comment" : "If there are no codes or filters, the entire code system is included. Note that the set of codes that are included may contain abstract codes. See ''Coding.system'' for further documentation about the correct value for the system element.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "uri"
}],
"condition" : ["vsd-1",
"vsd-2"],
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ValueSet.compose.include.version",
"path" : "ValueSet.compose.include.version",
"short" : "Specific version of the code system referred to",
"definition" : "The version of the code system that the codes are selected from, or the special version '*' for all versions.",
"comment" : "This is used when selecting the descendants of a concept - they may change between versions. If no version is specified, then the exact contents of the value set might not be known until a context of use binds it to a particular version. The special value '*' means all versions; It is at server discretion regarding expansions and which versions must be supported.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ValueSet.compose.include.concept",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "ConceptReference"
}],
"path" : "ValueSet.compose.include.concept",
"short" : "A concept defined in the system",
"definition" : "Specifies a concept to be included or excluded.",
"comment" : "The list of concepts is considered ordered, though the order might not have any particular significance. Typically, the order of an expansion follows that defined in the compose element.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"condition" : ["vsd-3"],
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ValueSet.compose.include.concept.code",
"path" : "ValueSet.compose.include.concept.code",
"short" : "Code or expression from system",
"definition" : "Specifies a code for the concept to be included or excluded.",
"comment" : "Expressions are allowed if defined by the underlying code system.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ValueSet.compose.include.concept.display",
"path" : "ValueSet.compose.include.concept.display",
"short" : "Text to display for this code for this value set in this valueset",
"definition" : "The text to display to the user for this concept in the context of this valueset. If no display is provided, then applications using the value set use the display specified for the code by the system.",
"comment" : "The value set resource allows for an alternative display to be specified for when this concept is used in this particular value set. See notes in the value set narrative about the correct use of this element.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ValueSet.compose.include.concept.designation",
"path" : "ValueSet.compose.include.concept.designation",
"short" : "Additional representations for this concept",
"definition" : "Additional representations for this concept when used in this value set - other languages, aliases, specialized purposes, used for particular purposes, etc.",
"comment" : "Concepts have both a ```display``` and an array of ```designation```. The display is equivalent to a special designation with an implied ```designation.use``` of \"primary code\" and a language equal to the [Resource Language](resource.html#language).",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "ValueSet.compose.include.concept.designation.language",
"path" : "ValueSet.compose.include.concept.designation.language",
"short" : "Human language of the designation",
"definition" : "The language this designation is defined for.",
"comment" : "In the absence of a language, the resource language applies.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "code"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "ValueSet.compose.include.concept.designation.use",
"path" : "ValueSet.compose.include.concept.designation.use",
"short" : "Types of uses of designations",
"definition" : "A code that represents types of uses of designations.",
"comment" : "If no use is provided, the designation can be assumed to be suitable for general display to a human user.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Coding"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ConceptDesignationUse"
}],
"strength" : "extensible",
"description" : "Details of how a designation would be used.",
"valueSet" : "http://hl7.org/fhir/ValueSet/designation-use"
}
},
{
"id" : "ValueSet.compose.include.concept.designation.value",
"path" : "ValueSet.compose.include.concept.designation.value",
"short" : "The text value for this designation",
"definition" : "The text value for this designation.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "string"
}]
},
{
"id" : "ValueSet.compose.include.filter",
"path" : "ValueSet.compose.include.filter",
"short" : "Select codes/concepts by their properties (including relationships)",
"definition" : "Select concepts by specify a matching criterion based on the properties (including relationships) defined by the system, or on filters defined by the system. If multiple filters are specified, they SHALL all be true.",
"comment" : "Selecting codes by specifying filters based on properties is only possible where the underlying code system defines appropriate properties. Note that in some cases, the underlying code system defines the logical concepts but not the literal codes for the concepts. In such cases, the literal definitions may be provided by a third party.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"condition" : ["vsd-3"],
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ValueSet.compose.include.filter.property",
"path" : "ValueSet.compose.include.filter.property",
"short" : "A property/filter defined by the code system",
"definition" : "A code that identifies a property or a filter defined in the code system.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ValueSet.compose.include.filter.op",
"path" : "ValueSet.compose.include.filter.op",
"short" : "= | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists",
"definition" : "The kind of operation to perform as a part of the filter criteria.",
"comment" : "In case filter.property represents a property of the system, the operation applies to the selected property. In case filter.property represents a filter of the system, the operation SHALL match one of the CodeSystem.filter.operator values.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "FilterOperator"
}],
"strength" : "required",
"description" : "The kind of operation to perform as a part of a property based filter.",
"valueSet" : "http://hl7.org/fhir/ValueSet/filter-operator|4.0.1"
},
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ValueSet.compose.include.filter.value",
"path" : "ValueSet.compose.include.filter.value",
"short" : "Code from the system, or regex criteria, or boolean value for exists",
"definition" : "The match value may be either a code defined by the system, or a string value, which is a regex match on the literal string of the property value (if the filter represents a property defined in CodeSystem) or of the system filter value (if the filter represents a filter defined in CodeSystem) when the operation is 'regex', or one of the values (true and false), when the operation is 'exists'.",
"comment" : "Use regex matching with care - full regex matching on every SNOMED CT term is prohibitive, for example.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ValueSet.compose.include.valueSet",
"path" : "ValueSet.compose.include.valueSet",
"short" : "Select the contents included in this value set",
"definition" : "Selects the concepts found in this value set (based on its value set definition). This is an absolute URI that is a reference to ValueSet.url. If multiple value sets are specified this includes the union of the contents of all of the referenced value sets.",
"comment" : "The value set URI is either a logical reference to a defined value set such as a [SNOMED CT reference set](snomedct.html#implicit), or a direct reference to a value set definition using ValueSet.url. The reference might not refer to an actual FHIR ValueSet resource; in this case, whatever is referred to is an implicit definition of a value set that needs to be clear about how versions are resolved.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ValueSet"]
}],
"condition" : ["vsd-1"],
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ValueSet.compose.exclude",
"path" : "ValueSet.compose.exclude",
"short" : "Explicitly exclude codes from a code system or other value sets",
"definition" : "Exclude one or more codes from the value set based on code system filters and/or other value sets.",
"comment" : "Usually this is used to selectively exclude codes that were included by subsumption in the inclusions. Any display names specified for the codes are ignored.",
"min" : 0,
"max" : "*",
"contentReference" : "#ValueSet.compose.include",
"condition" : ["vsd-2"],
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "ValueSet.expansion",
"path" : "ValueSet.expansion",
"short" : "Used when the value set is \"expanded\"",
"definition" : "A value set can also be \"expanded\", where the value set is turned into a simple collection of enumerated codes. This element holds the expansion, if it has been performed.",
"comment" : "Expansion is performed to produce a collection of codes that are ready to use for data entry or validation. Value set expansions are always considered to be stateless - they are a record of the set of codes in the value set at a point in time under a given set of conditions, and are not subject to ongoing maintenance.\n\nExpansion.parameter is a simplified list of parameters - a subset of the features of the [Parameters](parameters.html) resource.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "ValueSet.expansion.identifier",
"path" : "ValueSet.expansion.identifier",
"short" : "Identifies the value set expansion (business identifier)",
"definition" : "An identifier that uniquely identifies this expansion of the valueset, based on a unique combination of the provided parameters, the system default parameters, and the underlying system code system versions etc. Systems may re-use the same identifier as long as those factors remain the same, and the expansion is the same, but are not required to do so. This is a business identifier.",
"comment" : "Typically, this uri is a UUID (e.g. urn:uuid:8230ff20-c97a-4167-a59d-dc2cb9df16dd).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "uri"
}]
},
{
"id" : "ValueSet.expansion.timestamp",
"path" : "ValueSet.expansion.timestamp",
"short" : "Time ValueSet expansion happened",
"definition" : "The time at which the expansion was produced by the expanding system.",
"comment" : "This SHOULD be a fully populated instant, but in some circumstances, value sets are expanded by hand, and the expansion is published without that precision.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "dateTime"
}]
},
{
"id" : "ValueSet.expansion.total",
"path" : "ValueSet.expansion.total",
"short" : "Total number of codes in the expansion",
"definition" : "The total number of concepts in the expansion. If the number of concept nodes in this resource is less than the stated number, then the server can return more using the offset parameter.",
"comment" : "Paging only applies to flat expansions.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "integer"
}]
},
{
"id" : "ValueSet.expansion.offset",
"path" : "ValueSet.expansion.offset",
"short" : "Offset at which this resource starts",
"definition" : "If paging is being used, the offset at which this resource starts. I.e. this resource is a partial view into the expansion. If paging is not being used, this element SHALL NOT be present.",
"comment" : "Paging only applies to flat expansions. If a filter is applied, the count is the number of concepts that matched the filter, not the number of concepts in an unfiltered view of the expansion.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "integer"
}],
"meaningWhenMissing" : "Paging is not being used"
},
{
"id" : "ValueSet.expansion.parameter",
"path" : "ValueSet.expansion.parameter",
"short" : "Parameter that controlled the expansion process",
"definition" : "A parameter that controlled the expansion process. These parameters may be used by users of expanded value sets to check whether the expansion is suitable for a particular purpose, or to pick the correct expansion.",
"comment" : "The server decides which parameters to include here, but at a minimum, the list SHOULD include all of the parameters that affect the $expand operation. If the expansion will be persisted all of these parameters SHALL be included. If the codeSystem on the server has a specified version then this version SHALL be provided as a parameter in the expansion (note that not all code systems have a version).",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "ValueSet.expansion.parameter.name",
"path" : "ValueSet.expansion.parameter.name",
"short" : "Name as assigned by the client or server",
"definition" : "Name of the input parameter to the $expand operation; may be a server-assigned name for additional default or other server-supplied parameters used to control the expansion process.",
"comment" : "The names are assigned at the discretion of the server.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "string"
}]
},
{
"id" : "ValueSet.expansion.parameter.value[x]",
"path" : "ValueSet.expansion.parameter.value[x]",
"short" : "Value of the named parameter",
"definition" : "The value of the parameter.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
},
{
"code" : "boolean"
},
{
"code" : "integer"
},
{
"code" : "decimal"
},
{
"code" : "uri"
},
{
"code" : "code"
},
{
"code" : "dateTime"
}]
},
{
"id" : "ValueSet.expansion.contains",
"path" : "ValueSet.expansion.contains",
"short" : "Codes in the value set",
"definition" : "The codes that are contained in the value set expansion.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "vsd-6",
"severity" : "error",
"human" : "SHALL have a code or a display",
"expression" : "code.exists() or display.exists()",
"xpath" : "exists(f:code) or exists(f:display)"
},
{
"key" : "vsd-9",
"severity" : "error",
"human" : "Must have a code if not abstract",
"expression" : "code.exists() or abstract = true",
"xpath" : "exists(f:code) or (f:abstract/@value = true())"
},
{
"key" : "vsd-10",
"severity" : "error",
"human" : "Must have a system if a code is present",
"expression" : "code.empty() or system.exists()",
"xpath" : "exists(f:system) or not(exists(f:code))"
}]
},
{
"id" : "ValueSet.expansion.contains.system",
"path" : "ValueSet.expansion.contains.system",
"short" : "System value for the code",
"definition" : "An absolute URI which is the code system in which the code for this item in the expansion is defined.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "uri"
}]
},
{
"id" : "ValueSet.expansion.contains.abstract",
"path" : "ValueSet.expansion.contains.abstract",
"short" : "If user cannot select this entry",
"definition" : "If true, this entry is included in the expansion for navigational purposes, and the user cannot select the code directly as a proper value.",
"comment" : "This should not be understood to exclude its use for searching (e.g. by subsumption testing). The client should know whether it is appropriate for the user to select an abstract code or not.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "boolean"
}],
"meaningWhenMissing" : "If this is not populated, systems can assume that the concept it not abstract. This SHALL always be populated for abstract concepts"
},
{
"id" : "ValueSet.expansion.contains.inactive",
"path" : "ValueSet.expansion.contains.inactive",
"short" : "If concept is inactive in the code system",
"definition" : "If the concept is inactive in the code system that defines it. Inactive codes are those that are no longer to be used, but are maintained by the code system for understanding legacy data. It might not be known or specified whether an concept is inactive (and it may depend on the context of use).",
"comment" : "This should only have a value if the concept is inactive.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "boolean"
}]
},
{
"id" : "ValueSet.expansion.contains.version",
"path" : "ValueSet.expansion.contains.version",
"short" : "Version in which this code/display is defined",
"definition" : "The version of the code system from this code was taken. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.",
"comment" : "The exact value of the version string is specified by the system from which the code is derived.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}]
},
{
"id" : "ValueSet.expansion.contains.code",
"path" : "ValueSet.expansion.contains.code",
"short" : "Code - if blank, this is not a selectable code",
"definition" : "The code for this item in the expansion hierarchy. If this code is missing the entry in the hierarchy is a place holder (abstract) and does not represent a valid code in the value set.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "code"
}],
"condition" : ["vsd-6"]
},
{
"id" : "ValueSet.expansion.contains.display",
"path" : "ValueSet.expansion.contains.display",
"short" : "User display for the concept",
"definition" : "The recommended display for this item in the expansion.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"condition" : ["vsd-6"]
},
{
"id" : "ValueSet.expansion.contains.designation",
"path" : "ValueSet.expansion.contains.designation",
"short" : "Additional representations for this item",
"definition" : "Additional representations for this item - other languages, aliases, specialized purposes, used for particular purposes, etc. These are relevant when the conditions of the expansion do not fix to a single correct representation.",
"comment" : "The designations provided must be based on the value set and code system definitions.",
"min" : 0,
"max" : "*",
"contentReference" : "#ValueSet.compose.include.concept.designation"
},
{
"id" : "ValueSet.expansion.contains.contains",
"path" : "ValueSet.expansion.contains.contains",
"short" : "Codes contained under this entry",
"definition" : "Other codes and entries contained under this entry in the hierarchy.",
"comment" : "If the expansion uses this element, there is no implication about the logical relationship between them, and the structure cannot be used for logical inferencing. The structure exists to provide navigational assistance for helping human users to locate codes in the expansion.",
"min" : 0,
"max" : "*",
"contentReference" : "#ValueSet.expansion.contains"
}]
}
}
},
{
"fullUrl" : "http://hl7.org/fhir/StructureDefinition/VerificationResult",
"resource" : {
"resourceType" : "StructureDefinition",
"id" : "VerificationResult",
"meta" : {
"lastUpdated" : "2019-11-01T09:29:23.356+11:00"
},
"text" : {
"status" : "generated",
"div" : "Name Flags Card. Type Description & Constraints VerificationResult 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 target Σ 0..* Reference(Any) A resource that was validated
targetLocation Σ 0..* string The fhirpath location(s) within the resource that was validated
need Σ 0..1 CodeableConcept none | initial | periodic
Need (Preferred) status Σ 1..1 code attested | validated | in-process | req-revalid | val-fail | reval-fail
Status (Required) statusDate Σ 0..1 dateTime When the validation status was updated validationType Σ 0..1 CodeableConcept nothing | primary | multiple
Validation-type (Preferred) validationProcess Σ 0..* CodeableConcept The primary process by which the target is validated (edit check; value set; primary source; multiple sources; standalone; in context)
Validation-process (Example)
frequency 0..1 Timing Frequency of revalidation lastPerformed 0..1 dateTime The date/time validation was last completed (including failed validations) nextScheduled 0..1 date The date when target is next validated, if appropriate failureAction Σ 0..1 CodeableConcept fatal | warn | rec-only | none
Failure-action (Preferred) primarySource 0..* BackboneElement Information about the primary source(s) involved in validation
who 0..1 Reference(Organization | Practitioner | PractitionerRole) Reference to the primary source type Σ 0..* CodeableConcept Type of primary source (License Board; Primary Education; Continuing Education; Postal Service; Relationship owner; Registration Authority; legal source; issuing source; authoritative source)
Primary-source-type (Example)
communicationMethod Σ 0..* CodeableConcept Method for exchanging information with the primary source
VerificationResult Communication Method (Example)
validationStatus 0..1 CodeableConcept successful | failed | unknown
Validation-status (Preferred) validationDate 0..1 dateTime When the target was validated against the primary source canPushUpdates Σ 0..1 CodeableConcept yes | no | undetermined
Can-push-updates (Preferred) pushTypeAvailable 0..* CodeableConcept specific | any | source
Push-type-available (Preferred)
attestation 0..1 BackboneElement Information about the entity attesting to information who Σ 0..1 Reference(Practitioner | PractitionerRole | Organization) The individual or organization attesting to information onBehalfOf Σ 0..1 Reference(Organization | Practitioner | PractitionerRole) When the who is asserting on behalf of another (organization or individual) communicationMethod Σ 0..1 CodeableConcept The method by which attested information was submitted/retrieved
VerificationResult Communication Method (Example) date Σ 0..1 date The date the information was attested to sourceIdentityCertificate 0..1 string A digital identity certificate associated with the attestation source proxyIdentityCertificate 0..1 string A digital identity certificate associated with the proxy entity submitting attested information on behalf of the attestation source proxySignature 0..1 Signature Proxy signature sourceSignature 0..1 Signature Attester signature validator 0..* BackboneElement Information about the entity validating information
organization 1..1 Reference(Organization) Reference to the organization validating information identityCertificate 0..1 string A digital identity certificate associated with the validator attestationSignature 0..1 Signature Validator signature
Documentation for this format
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Base.Workflow"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 0
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "business"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "pa"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/VerificationResult",
"version" : "4.0.1",
"name" : "VerificationResult",
"status" : "draft",
"date" : "2019-11-01T09:29:23+11:00",
"publisher" : "Health Level Seven International (Patient Administration)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/pafm/index.cfm"
}]
}],
"description" : "Describes validation requirements, source(s), status and dates for one or more elements.",
"fhirVersion" : "4.0.1",
"mapping" : [{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/fivews",
"name" : "FiveWs Pattern Mapping"
},
{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
}],
"kind" : "resource",
"abstract" : false,
"type" : "VerificationResult",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "VerificationResult",
"path" : "VerificationResult",
"short" : "Describes validation requirements, source(s), status and dates for one or more elements",
"definition" : "Describes validation requirements, source(s), status and dates for one or more elements.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "VerificationResult",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "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",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.`div`.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
}]
},
{
"id" : "VerificationResult.id",
"path" : "VerificationResult.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "VerificationResult.meta",
"path" : "VerificationResult.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "VerificationResult.implicitRules",
"path" : "VerificationResult.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "VerificationResult.language",
"path" : "VerificationResult.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "VerificationResult.text",
"path" : "VerificationResult.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "VerificationResult.contained",
"path" : "VerificationResult.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "VerificationResult.extension",
"path" : "VerificationResult.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "VerificationResult.modifierExtension",
"path" : "VerificationResult.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "VerificationResult.target",
"path" : "VerificationResult.target",
"short" : "A resource that was validated",
"definition" : "A resource that was validated.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "VerificationResult.target",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "VerificationResult.targetLocation",
"path" : "VerificationResult.targetLocation",
"short" : "The fhirpath location(s) within the resource that was validated",
"definition" : "The fhirpath location(s) within the resource that was validated.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "VerificationResult.targetLocation",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "VerificationResult.need",
"path" : "VerificationResult.need",
"short" : "none | initial | periodic",
"definition" : "The frequency with which the target must be validated (none; initial; periodic).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "VerificationResult.need",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "need"
}],
"strength" : "preferred",
"description" : "The frequency with which the target must be validated.",
"valueSet" : "http://hl7.org/fhir/ValueSet/verificationresult-need"
}
},
{
"id" : "VerificationResult.status",
"path" : "VerificationResult.status",
"short" : "attested | validated | in-process | req-revalid | val-fail | reval-fail",
"definition" : "The validation status of the target (attested; validated; in process; requires revalidation; validation failed; revalidation failed).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "VerificationResult.status",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "status"
}],
"strength" : "required",
"description" : "The validation status of the target.",
"valueSet" : "http://hl7.org/fhir/ValueSet/verificationresult-status|4.0.1"
}
},
{
"id" : "VerificationResult.statusDate",
"path" : "VerificationResult.statusDate",
"short" : "When the validation status was updated",
"definition" : "When the validation status was updated.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "VerificationResult.statusDate",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "VerificationResult.validationType",
"path" : "VerificationResult.validationType",
"short" : "nothing | primary | multiple",
"definition" : "What the target is validated against (nothing; primary source; multiple sources).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "VerificationResult.validationType",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "validation-type"
}],
"strength" : "preferred",
"description" : "What the target is validated against.",
"valueSet" : "http://hl7.org/fhir/ValueSet/verificationresult-validation-type"
}
},
{
"id" : "VerificationResult.validationProcess",
"path" : "VerificationResult.validationProcess",
"short" : "The primary process by which the target is validated (edit check; value set; primary source; multiple sources; standalone; in context)",
"definition" : "The primary process by which the target is validated (edit check; value set; primary source; multiple sources; standalone; in context).",
"min" : 0,
"max" : "*",
"base" : {
"path" : "VerificationResult.validationProcess",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "validation-process"
}],
"strength" : "example",
"description" : "The primary process by which the target is validated.",
"valueSet" : "http://hl7.org/fhir/ValueSet/verificationresult-validation-process"
}
},
{
"id" : "VerificationResult.frequency",
"path" : "VerificationResult.frequency",
"short" : "Frequency of revalidation",
"definition" : "Frequency of revalidation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "VerificationResult.frequency",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Timing"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "VerificationResult.lastPerformed",
"path" : "VerificationResult.lastPerformed",
"short" : "The date/time validation was last completed (including failed validations)",
"definition" : "The date/time validation was last completed (including failed validations).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "VerificationResult.lastPerformed",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "VerificationResult.nextScheduled",
"path" : "VerificationResult.nextScheduled",
"short" : "The date when target is next validated, if appropriate",
"definition" : "The date when target is next validated, if appropriate.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "VerificationResult.nextScheduled",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "date"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "VerificationResult.failureAction",
"path" : "VerificationResult.failureAction",
"short" : "fatal | warn | rec-only | none",
"definition" : "The result if validation fails (fatal; warning; record only; none).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "VerificationResult.failureAction",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "failure-action"
}],
"strength" : "preferred",
"description" : "The result if validation fails.",
"valueSet" : "http://hl7.org/fhir/ValueSet/verificationresult-failure-action"
}
},
{
"id" : "VerificationResult.primarySource",
"path" : "VerificationResult.primarySource",
"short" : "Information about the primary source(s) involved in validation",
"definition" : "Information about the primary source(s) involved in validation.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "VerificationResult.primarySource",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "VerificationResult.primarySource.id",
"path" : "VerificationResult.primarySource.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "VerificationResult.primarySource.extension",
"path" : "VerificationResult.primarySource.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "VerificationResult.primarySource.modifierExtension",
"path" : "VerificationResult.primarySource.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "VerificationResult.primarySource.who",
"path" : "VerificationResult.primarySource.who",
"short" : "Reference to the primary source",
"definition" : "Reference to the primary source.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "VerificationResult.primarySource.who",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization",
"http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.who"
}]
},
{
"id" : "VerificationResult.primarySource.type",
"path" : "VerificationResult.primarySource.type",
"short" : "Type of primary source (License Board; Primary Education; Continuing Education; Postal Service; Relationship owner; Registration Authority; legal source; issuing source; authoritative source)",
"definition" : "Type of primary source (License Board; Primary Education; Continuing Education; Postal Service; Relationship owner; Registration Authority; legal source; issuing source; authoritative source).",
"min" : 0,
"max" : "*",
"base" : {
"path" : "VerificationResult.primarySource.type",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "primary-source-type"
}],
"strength" : "example",
"description" : "Type of the validation primary source.",
"valueSet" : "http://hl7.org/fhir/ValueSet/verificationresult-primary-source-type"
}
},
{
"id" : "VerificationResult.primarySource.communicationMethod",
"path" : "VerificationResult.primarySource.communicationMethod",
"short" : "Method for exchanging information with the primary source",
"definition" : "Method for communicating with the primary source (manual; API; Push).",
"min" : 0,
"max" : "*",
"base" : {
"path" : "VerificationResult.primarySource.communicationMethod",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "communication-method"
}],
"strength" : "example",
"description" : "Method for communicating with the data source (manual; API; Push).",
"valueSet" : "http://hl7.org/fhir/ValueSet/verificationresult-communication-method"
}
},
{
"id" : "VerificationResult.primarySource.validationStatus",
"path" : "VerificationResult.primarySource.validationStatus",
"short" : "successful | failed | unknown",
"definition" : "Status of the validation of the target against the primary source (successful; failed; unknown).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "VerificationResult.primarySource.validationStatus",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "validation-status"
}],
"strength" : "preferred",
"description" : "Status of the validation of the target against the primary source.",
"valueSet" : "http://hl7.org/fhir/ValueSet/verificationresult-validation-status"
}
},
{
"id" : "VerificationResult.primarySource.validationDate",
"path" : "VerificationResult.primarySource.validationDate",
"short" : "When the target was validated against the primary source",
"definition" : "When the target was validated against the primary source.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "VerificationResult.primarySource.validationDate",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "VerificationResult.primarySource.canPushUpdates",
"path" : "VerificationResult.primarySource.canPushUpdates",
"short" : "yes | no | undetermined",
"definition" : "Ability of the primary source to push updates/alerts (yes; no; undetermined).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "VerificationResult.primarySource.canPushUpdates",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "can-push-updates"
}],
"strength" : "preferred",
"description" : "Ability of the primary source to push updates/alerts.",
"valueSet" : "http://hl7.org/fhir/ValueSet/verificationresult-can-push-updates"
}
},
{
"id" : "VerificationResult.primarySource.pushTypeAvailable",
"path" : "VerificationResult.primarySource.pushTypeAvailable",
"short" : "specific | any | source",
"definition" : "Type of alerts/updates the primary source can send (specific requested changes; any changes; as defined by source).",
"min" : 0,
"max" : "*",
"base" : {
"path" : "VerificationResult.primarySource.pushTypeAvailable",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "push-type-available"
}],
"strength" : "preferred",
"description" : "Type of alerts/updates the primary source can send.",
"valueSet" : "http://hl7.org/fhir/ValueSet/verificationresult-push-type-available"
}
},
{
"id" : "VerificationResult.attestation",
"path" : "VerificationResult.attestation",
"short" : "Information about the entity attesting to information",
"definition" : "Information about the entity attesting to information.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "VerificationResult.attestation",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "VerificationResult.attestation.id",
"path" : "VerificationResult.attestation.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "VerificationResult.attestation.extension",
"path" : "VerificationResult.attestation.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "VerificationResult.attestation.modifierExtension",
"path" : "VerificationResult.attestation.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "VerificationResult.attestation.who",
"path" : "VerificationResult.attestation.who",
"short" : "The individual or organization attesting to information",
"definition" : "The individual or organization attesting to information.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "VerificationResult.attestation.who",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "VerificationResult.attestation.onBehalfOf",
"path" : "VerificationResult.attestation.onBehalfOf",
"short" : "When the who is asserting on behalf of another (organization or individual)",
"definition" : "When the who is asserting on behalf of another (organization or individual).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "VerificationResult.attestation.onBehalfOf",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization",
"http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "VerificationResult.attestation.communicationMethod",
"path" : "VerificationResult.attestation.communicationMethod",
"short" : "The method by which attested information was submitted/retrieved",
"definition" : "The method by which attested information was submitted/retrieved (manual; API; Push).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "VerificationResult.attestation.communicationMethod",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "communication-method"
}],
"strength" : "example",
"description" : "Method for communicating with the data source (manual; API; Push).",
"valueSet" : "http://hl7.org/fhir/ValueSet/verificationresult-communication-method"
}
},
{
"id" : "VerificationResult.attestation.date",
"path" : "VerificationResult.attestation.date",
"short" : "The date the information was attested to",
"definition" : "The date the information was attested to.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "VerificationResult.attestation.date",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "date"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "VerificationResult.attestation.sourceIdentityCertificate",
"path" : "VerificationResult.attestation.sourceIdentityCertificate",
"short" : "A digital identity certificate associated with the attestation source",
"definition" : "A digital identity certificate associated with the attestation source.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "VerificationResult.attestation.sourceIdentityCertificate",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "VerificationResult.attestation.proxyIdentityCertificate",
"path" : "VerificationResult.attestation.proxyIdentityCertificate",
"short" : "A digital identity certificate associated with the proxy entity submitting attested information on behalf of the attestation source",
"definition" : "A digital identity certificate associated with the proxy entity submitting attested information on behalf of the attestation source.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "VerificationResult.attestation.proxyIdentityCertificate",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "VerificationResult.attestation.proxySignature",
"path" : "VerificationResult.attestation.proxySignature",
"short" : "Proxy signature",
"definition" : "Signed assertion by the proxy entity indicating that they have the right to submit attested information on behalf of the attestation source.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "VerificationResult.attestation.proxySignature",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Signature"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "VerificationResult.attestation.sourceSignature",
"path" : "VerificationResult.attestation.sourceSignature",
"short" : "Attester signature",
"definition" : "Signed assertion by the attestation source that they have attested to the information.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "VerificationResult.attestation.sourceSignature",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Signature"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "VerificationResult.validator",
"path" : "VerificationResult.validator",
"short" : "Information about the entity validating information",
"definition" : "Information about the entity validating information.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "VerificationResult.validator",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "VerificationResult.validator.id",
"path" : "VerificationResult.validator.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "VerificationResult.validator.extension",
"path" : "VerificationResult.validator.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "VerificationResult.validator.modifierExtension",
"path" : "VerificationResult.validator.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "VerificationResult.validator.organization",
"path" : "VerificationResult.validator.organization",
"short" : "Reference to the organization validating information",
"definition" : "Reference to the organization validating information.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "VerificationResult.validator.organization",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "VerificationResult.validator.identityCertificate",
"path" : "VerificationResult.validator.identityCertificate",
"short" : "A digital identity certificate associated with the validator",
"definition" : "A digital identity certificate associated with the validator.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "VerificationResult.validator.identityCertificate",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "VerificationResult.validator.attestationSignature",
"path" : "VerificationResult.validator.attestationSignature",
"short" : "Validator signature",
"definition" : "Signed assertion by the validator that they have validated the information.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "VerificationResult.validator.attestationSignature",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Signature"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
}]
},
"differential" : {
"element" : [{
"id" : "VerificationResult",
"path" : "VerificationResult",
"short" : "Describes validation requirements, source(s), status and dates for one or more elements",
"definition" : "Describes validation requirements, source(s), status and dates for one or more elements.",
"min" : 0,
"max" : "*"
},
{
"id" : "VerificationResult.target",
"path" : "VerificationResult.target",
"short" : "A resource that was validated",
"definition" : "A resource that was validated.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"isSummary" : true
},
{
"id" : "VerificationResult.targetLocation",
"path" : "VerificationResult.targetLocation",
"short" : "The fhirpath location(s) within the resource that was validated",
"definition" : "The fhirpath location(s) within the resource that was validated.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "VerificationResult.need",
"path" : "VerificationResult.need",
"short" : "none | initial | periodic",
"definition" : "The frequency with which the target must be validated (none; initial; periodic).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "need"
}],
"strength" : "preferred",
"description" : "The frequency with which the target must be validated.",
"valueSet" : "http://hl7.org/fhir/ValueSet/verificationresult-need"
}
},
{
"id" : "VerificationResult.status",
"path" : "VerificationResult.status",
"short" : "attested | validated | in-process | req-revalid | val-fail | reval-fail",
"definition" : "The validation status of the target (attested; validated; in process; requires revalidation; validation failed; revalidation failed).",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "status"
}],
"strength" : "required",
"description" : "The validation status of the target.",
"valueSet" : "http://hl7.org/fhir/ValueSet/verificationresult-status|4.0.1"
}
},
{
"id" : "VerificationResult.statusDate",
"path" : "VerificationResult.statusDate",
"short" : "When the validation status was updated",
"definition" : "When the validation status was updated.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "dateTime"
}],
"isSummary" : true
},
{
"id" : "VerificationResult.validationType",
"path" : "VerificationResult.validationType",
"short" : "nothing | primary | multiple",
"definition" : "What the target is validated against (nothing; primary source; multiple sources).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "validation-type"
}],
"strength" : "preferred",
"description" : "What the target is validated against.",
"valueSet" : "http://hl7.org/fhir/ValueSet/verificationresult-validation-type"
}
},
{
"id" : "VerificationResult.validationProcess",
"path" : "VerificationResult.validationProcess",
"short" : "The primary process by which the target is validated (edit check; value set; primary source; multiple sources; standalone; in context)",
"definition" : "The primary process by which the target is validated (edit check; value set; primary source; multiple sources; standalone; in context).",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "validation-process"
}],
"strength" : "example",
"description" : "The primary process by which the target is validated.",
"valueSet" : "http://hl7.org/fhir/ValueSet/verificationresult-validation-process"
}
},
{
"id" : "VerificationResult.frequency",
"path" : "VerificationResult.frequency",
"short" : "Frequency of revalidation",
"definition" : "Frequency of revalidation.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Timing"
}]
},
{
"id" : "VerificationResult.lastPerformed",
"path" : "VerificationResult.lastPerformed",
"short" : "The date/time validation was last completed (including failed validations)",
"definition" : "The date/time validation was last completed (including failed validations).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "dateTime"
}]
},
{
"id" : "VerificationResult.nextScheduled",
"path" : "VerificationResult.nextScheduled",
"short" : "The date when target is next validated, if appropriate",
"definition" : "The date when target is next validated, if appropriate.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "date"
}]
},
{
"id" : "VerificationResult.failureAction",
"path" : "VerificationResult.failureAction",
"short" : "fatal | warn | rec-only | none",
"definition" : "The result if validation fails (fatal; warning; record only; none).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "failure-action"
}],
"strength" : "preferred",
"description" : "The result if validation fails.",
"valueSet" : "http://hl7.org/fhir/ValueSet/verificationresult-failure-action"
}
},
{
"id" : "VerificationResult.primarySource",
"path" : "VerificationResult.primarySource",
"short" : "Information about the primary source(s) involved in validation",
"definition" : "Information about the primary source(s) involved in validation.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "VerificationResult.primarySource.who",
"path" : "VerificationResult.primarySource.who",
"short" : "Reference to the primary source",
"definition" : "Reference to the primary source.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization",
"http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole"]
}],
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.who"
}]
},
{
"id" : "VerificationResult.primarySource.type",
"path" : "VerificationResult.primarySource.type",
"short" : "Type of primary source (License Board; Primary Education; Continuing Education; Postal Service; Relationship owner; Registration Authority; legal source; issuing source; authoritative source)",
"definition" : "Type of primary source (License Board; Primary Education; Continuing Education; Postal Service; Relationship owner; Registration Authority; legal source; issuing source; authoritative source).",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "primary-source-type"
}],
"strength" : "example",
"description" : "Type of the validation primary source.",
"valueSet" : "http://hl7.org/fhir/ValueSet/verificationresult-primary-source-type"
}
},
{
"id" : "VerificationResult.primarySource.communicationMethod",
"path" : "VerificationResult.primarySource.communicationMethod",
"short" : "Method for exchanging information with the primary source",
"definition" : "Method for communicating with the primary source (manual; API; Push).",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "communication-method"
}],
"strength" : "example",
"description" : "Method for communicating with the data source (manual; API; Push).",
"valueSet" : "http://hl7.org/fhir/ValueSet/verificationresult-communication-method"
}
},
{
"id" : "VerificationResult.primarySource.validationStatus",
"path" : "VerificationResult.primarySource.validationStatus",
"short" : "successful | failed | unknown",
"definition" : "Status of the validation of the target against the primary source (successful; failed; unknown).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "validation-status"
}],
"strength" : "preferred",
"description" : "Status of the validation of the target against the primary source.",
"valueSet" : "http://hl7.org/fhir/ValueSet/verificationresult-validation-status"
}
},
{
"id" : "VerificationResult.primarySource.validationDate",
"path" : "VerificationResult.primarySource.validationDate",
"short" : "When the target was validated against the primary source",
"definition" : "When the target was validated against the primary source.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "dateTime"
}]
},
{
"id" : "VerificationResult.primarySource.canPushUpdates",
"path" : "VerificationResult.primarySource.canPushUpdates",
"short" : "yes | no | undetermined",
"definition" : "Ability of the primary source to push updates/alerts (yes; no; undetermined).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "can-push-updates"
}],
"strength" : "preferred",
"description" : "Ability of the primary source to push updates/alerts.",
"valueSet" : "http://hl7.org/fhir/ValueSet/verificationresult-can-push-updates"
}
},
{
"id" : "VerificationResult.primarySource.pushTypeAvailable",
"path" : "VerificationResult.primarySource.pushTypeAvailable",
"short" : "specific | any | source",
"definition" : "Type of alerts/updates the primary source can send (specific requested changes; any changes; as defined by source).",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "push-type-available"
}],
"strength" : "preferred",
"description" : "Type of alerts/updates the primary source can send.",
"valueSet" : "http://hl7.org/fhir/ValueSet/verificationresult-push-type-available"
}
},
{
"id" : "VerificationResult.attestation",
"path" : "VerificationResult.attestation",
"short" : "Information about the entity attesting to information",
"definition" : "Information about the entity attesting to information.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "VerificationResult.attestation.who",
"path" : "VerificationResult.attestation.who",
"short" : "The individual or organization attesting to information",
"definition" : "The individual or organization attesting to information.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"isSummary" : true
},
{
"id" : "VerificationResult.attestation.onBehalfOf",
"path" : "VerificationResult.attestation.onBehalfOf",
"short" : "When the who is asserting on behalf of another (organization or individual)",
"definition" : "When the who is asserting on behalf of another (organization or individual).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization",
"http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole"]
}],
"isSummary" : true
},
{
"id" : "VerificationResult.attestation.communicationMethod",
"path" : "VerificationResult.attestation.communicationMethod",
"short" : "The method by which attested information was submitted/retrieved",
"definition" : "The method by which attested information was submitted/retrieved (manual; API; Push).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "communication-method"
}],
"strength" : "example",
"description" : "Method for communicating with the data source (manual; API; Push).",
"valueSet" : "http://hl7.org/fhir/ValueSet/verificationresult-communication-method"
}
},
{
"id" : "VerificationResult.attestation.date",
"path" : "VerificationResult.attestation.date",
"short" : "The date the information was attested to",
"definition" : "The date the information was attested to.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "date"
}],
"isSummary" : true
},
{
"id" : "VerificationResult.attestation.sourceIdentityCertificate",
"path" : "VerificationResult.attestation.sourceIdentityCertificate",
"short" : "A digital identity certificate associated with the attestation source",
"definition" : "A digital identity certificate associated with the attestation source.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}]
},
{
"id" : "VerificationResult.attestation.proxyIdentityCertificate",
"path" : "VerificationResult.attestation.proxyIdentityCertificate",
"short" : "A digital identity certificate associated with the proxy entity submitting attested information on behalf of the attestation source",
"definition" : "A digital identity certificate associated with the proxy entity submitting attested information on behalf of the attestation source.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}]
},
{
"id" : "VerificationResult.attestation.proxySignature",
"path" : "VerificationResult.attestation.proxySignature",
"short" : "Proxy signature",
"definition" : "Signed assertion by the proxy entity indicating that they have the right to submit attested information on behalf of the attestation source.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Signature"
}]
},
{
"id" : "VerificationResult.attestation.sourceSignature",
"path" : "VerificationResult.attestation.sourceSignature",
"short" : "Attester signature",
"definition" : "Signed assertion by the attestation source that they have attested to the information.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Signature"
}]
},
{
"id" : "VerificationResult.validator",
"path" : "VerificationResult.validator",
"short" : "Information about the entity validating information",
"definition" : "Information about the entity validating information.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "VerificationResult.validator.organization",
"path" : "VerificationResult.validator.organization",
"short" : "Reference to the organization validating information",
"definition" : "Reference to the organization validating information.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization"]
}]
},
{
"id" : "VerificationResult.validator.identityCertificate",
"path" : "VerificationResult.validator.identityCertificate",
"short" : "A digital identity certificate associated with the validator",
"definition" : "A digital identity certificate associated with the validator.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}]
},
{
"id" : "VerificationResult.validator.attestationSignature",
"path" : "VerificationResult.validator.attestationSignature",
"short" : "Validator signature",
"definition" : "Signed assertion by the validator that they have validated the information.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Signature"
}]
}]
}
}
},
{
"fullUrl" : "http://hl7.org/fhir/StructureDefinition/VisionPrescription",
"resource" : {
"resourceType" : "StructureDefinition",
"id" : "VisionPrescription",
"meta" : {
"lastUpdated" : "2019-11-01T09:29:23.356+11:00"
},
"text" : {
"status" : "generated",
"div" : "Name Flags Card. Type Description & Constraints VisionPrescription TU DomainResource Prescription for vision correction products for a patient
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension identifier 0..* Identifier Business Identifier for vision prescription
status ?!Σ 1..1 code active | cancelled | draft | entered-in-error
Financial Resource Status Codes (Required) created Σ 1..1 dateTime Response creation date patient Σ 1..1 Reference(Patient) Who prescription is for encounter 0..1 Reference(Encounter) Created during encounter / admission / stay dateWritten Σ 1..1 dateTime When prescription was authorized prescriber Σ 1..1 Reference(Practitioner | PractitionerRole) Who authorized the vision prescription lensSpecification Σ 1..* BackboneElement Vision lens authorization
product Σ 1..1 CodeableConcept Product to be supplied
Example Vision Prescription Product Codes (Example) eye Σ 1..1 code right | left
VisionEyes (Required) sphere 0..1 decimal Power of the lens cylinder 0..1 decimal Lens power for astigmatism axis 0..1 integer Lens meridian which contain no power for astigmatism prism 0..* BackboneElement Eye alignment compensation
amount 1..1 decimal Amount of adjustment base 1..1 code up | down | in | out
VisionBase (Required) add 0..1 decimal Added power for multifocal levels power 0..1 decimal Contact lens power backCurve 0..1 decimal Contact lens back curvature diameter 0..1 decimal Contact lens diameter duration 0..1 SimpleQuantity Lens wear duration color 0..1 string Color required brand 0..1 string Brand required note 0..* Annotation Notes for coatings
Documentation for this format
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Clinical.Care Provision"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 2
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "patient"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "fm"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/VisionPrescription",
"version" : "4.0.1",
"name" : "VisionPrescription",
"status" : "draft",
"date" : "2019-11-01T09:29:23+11:00",
"publisher" : "Health Level Seven International (Financial Management)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/fm/index.cfm"
}]
}],
"description" : "An authorization for the provision of glasses and/or contact lenses to a patient.",
"fhirVersion" : "4.0.1",
"mapping" : [{
"identity" : "workflow",
"uri" : "http://hl7.org/fhir/workflow",
"name" : "Workflow Pattern"
},
{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/fivews",
"name" : "FiveWs Pattern Mapping"
},
{
"identity" : "v2",
"uri" : "http://hl7.org/v2",
"name" : "HL7 v2 Mapping"
}],
"kind" : "resource",
"abstract" : false,
"type" : "VisionPrescription",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "VisionPrescription",
"path" : "VisionPrescription",
"short" : "Prescription for vision correction products for a patient",
"definition" : "An authorization for the provision of glasses and/or contact lenses to a patient.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "VisionPrescription",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "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",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.`div`.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "workflow",
"map" : "Request"
},
{
"identity" : "rim",
"map" : "CombinedVisionRequest"
}]
},
{
"id" : "VisionPrescription.id",
"path" : "VisionPrescription.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "VisionPrescription.meta",
"path" : "VisionPrescription.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "VisionPrescription.implicitRules",
"path" : "VisionPrescription.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "VisionPrescription.language",
"path" : "VisionPrescription.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "VisionPrescription.text",
"path" : "VisionPrescription.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "VisionPrescription.contained",
"path" : "VisionPrescription.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "VisionPrescription.extension",
"path" : "VisionPrescription.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "VisionPrescription.modifierExtension",
"path" : "VisionPrescription.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "VisionPrescription.identifier",
"path" : "VisionPrescription.identifier",
"short" : "Business Identifier for vision prescription",
"definition" : "A unique identifier assigned to this vision prescription.",
"requirements" : "Allows vision prescriptions to be distinguished and referenced.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "VisionPrescription.identifier",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Identifier"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.identifier"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "v2",
"map" : "ORC-2-Placer Order Number / ORC-3-Filler Order Number"
},
{
"identity" : "rim",
"map" : "id"
}]
},
{
"id" : "VisionPrescription.status",
"path" : "VisionPrescription.status",
"short" : "active | cancelled | draft | entered-in-error",
"definition" : "The status of the resource instance.",
"comment" : "This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.",
"requirements" : "Need to track the status of the resource as 'draft' resources may undergo further edits while 'active' resources are immutable and may only have their status changed to 'cancelled'.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "VisionPrescription.status",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "VisionStatus"
}],
"strength" : "required",
"description" : "A code specifying the state of the resource instance.",
"valueSet" : "http://hl7.org/fhir/ValueSet/fm-status|4.0.1"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.status"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
},
{
"identity" : "rim",
"map" : "Act.status"
}]
},
{
"id" : "VisionPrescription.created",
"path" : "VisionPrescription.created",
"short" : "Response creation date",
"definition" : "The date this resource was created.",
"requirements" : "Need to record a timestamp for use by both the recipient and the issuer.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "VisionPrescription.created",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "VisionPrescription.patient",
"path" : "VisionPrescription.patient",
"short" : "Who prescription is for",
"definition" : "A resource reference to the person to whom the vision prescription applies.",
"requirements" : "Needed to identify the patient for whom the vision prescription has been issued.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "VisionPrescription.patient",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.subject"
},
{
"identity" : "w5",
"map" : "FiveWs.subject[x]"
},
{
"identity" : "v2",
"map" : "PID-3-Patient ID List"
},
{
"identity" : "rim",
"map" : "subject.role"
},
{
"identity" : "w5",
"map" : "FiveWs.subject"
}]
},
{
"id" : "VisionPrescription.encounter",
"path" : "VisionPrescription.encounter",
"short" : "Created during encounter / admission / stay",
"definition" : "A reference to a resource that identifies the particular occurrence of contact between patient and health care provider during which the prescription was issued.",
"requirements" : "Used in some jurisdictions to link clinical events to claim items.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "VisionPrescription.encounter",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Encounter"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.context"
},
{
"identity" : "w5",
"map" : "FiveWs.context"
},
{
"identity" : "v2",
"map" : "PV1-19-Visit Number"
},
{
"identity" : "rim",
"map" : "componentOf.patientEncounter"
}]
},
{
"id" : "VisionPrescription.dateWritten",
"path" : "VisionPrescription.dateWritten",
"short" : "When prescription was authorized",
"definition" : "The date (and perhaps time) when the prescription was written.",
"comment" : "Jurisdictions determine the valid lifetime of a prescription. Typically vision prescriptions are valid for two years from the date written.",
"requirements" : "Need to record a timestamp for use by both the recipient and the issuer.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "VisionPrescription.dateWritten",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.authoredOn"
},
{
"identity" : "w5",
"map" : "FiveWs.recorded"
},
{
"identity" : "v2",
"map" : "RXE-32-Original Order Date/Time / ORC-9-Date/Time of Transaction"
},
{
"identity" : "rim",
"map" : "author.time"
}]
},
{
"id" : "VisionPrescription.prescriber",
"path" : "VisionPrescription.prescriber",
"short" : "Who authorized the vision prescription",
"definition" : "The healthcare professional responsible for authorizing the prescription.",
"requirements" : "Need to record the authorizing practitioner.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "VisionPrescription.prescriber",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.requester"
},
{
"identity" : "w5",
"map" : "FiveWs.author"
},
{
"identity" : "v2",
"map" : "RXE-13-Ordering Provider's DEA Number / RXO-14-Ordering Provider's DEA Number / RXE-14-Pharmacist/Treatment Supplier's Verifier ID / RXO-15-Pharmacist/Treatment Supplier's Verifier ID / ORC-12-Ordering Provider / PRT-5-Participation Person: PRT-4-Participation='OP' (all but last deprecated)"
},
{
"identity" : "rim",
"map" : "author.role"
}]
},
{
"id" : "VisionPrescription.lensSpecification",
"path" : "VisionPrescription.lensSpecification",
"short" : "Vision lens authorization",
"definition" : "Contain the details of the individual lens specifications and serves as the authorization for the fullfillment by certified professionals.",
"min" : 1,
"max" : "*",
"base" : {
"path" : "VisionPrescription.lensSpecification",
"min" : 1,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "component.supplyEvent"
}]
},
{
"id" : "VisionPrescription.lensSpecification.id",
"path" : "VisionPrescription.lensSpecification.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "VisionPrescription.lensSpecification.extension",
"path" : "VisionPrescription.lensSpecification.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "VisionPrescription.lensSpecification.modifierExtension",
"path" : "VisionPrescription.lensSpecification.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "VisionPrescription.lensSpecification.product",
"path" : "VisionPrescription.lensSpecification.product",
"short" : "Product to be supplied",
"definition" : "Identifies the type of vision correction product which is required for the patient.",
"requirements" : "Need to identify whether glasses or contacts.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "VisionPrescription.lensSpecification.product",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "VisionProduct"
}],
"strength" : "example",
"description" : "A coded concept describing the vision products.",
"valueSet" : "http://hl7.org/fhir/ValueSet/vision-product"
},
"mapping" : [{
"identity" : "v2",
"map" : "RXE-2-Give Code / RXO-1-Requested Give Code / RXD-2-Dispense/Give Code"
},
{
"identity" : "rim",
"map" : "consumable.role"
}]
},
{
"id" : "VisionPrescription.lensSpecification.eye",
"path" : "VisionPrescription.lensSpecification.eye",
"short" : "right | left",
"definition" : "The eye for which the lens specification applies.",
"comment" : "May also appear as OD (oculus dexter) for the right eye and OS (oculus siniter) for the left eye.",
"requirements" : "Needed to identify which eye the lens specification applies to.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "VisionPrescription.lensSpecification.eye",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "VisionEyes"
}],
"strength" : "required",
"description" : "A coded concept listing the eye codes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/vision-eye-codes|4.0.1"
},
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "VisionPrescription.lensSpecification.sphere",
"path" : "VisionPrescription.lensSpecification.sphere",
"short" : "Power of the lens",
"definition" : "Lens power measured in dioptres (0.25 units).",
"comment" : "The value is negative for near-sighted and positive for far sighted.\nOften insurance will not cover a lens with power between +75 and -75.",
"requirements" : "Standard lens prescription measures.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "VisionPrescription.lensSpecification.sphere",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "decimal"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "VisionPrescription.lensSpecification.cylinder",
"path" : "VisionPrescription.lensSpecification.cylinder",
"short" : "Lens power for astigmatism",
"definition" : "Power adjustment for astigmatism measured in dioptres (0.25 units).",
"requirements" : "Standard lens prescription measures.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "VisionPrescription.lensSpecification.cylinder",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "decimal"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "VisionPrescription.lensSpecification.axis",
"path" : "VisionPrescription.lensSpecification.axis",
"short" : "Lens meridian which contain no power for astigmatism",
"definition" : "Adjustment for astigmatism measured in integer degrees.",
"comment" : "The limits are +180 and -180 degrees.",
"requirements" : "Standard lens prescription measures.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "VisionPrescription.lensSpecification.axis",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "integer"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "VisionPrescription.lensSpecification.prism",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "Prism"
}],
"path" : "VisionPrescription.lensSpecification.prism",
"short" : "Eye alignment compensation",
"definition" : "Allows for adjustment on two axis.",
"requirements" : "Standard lens prescription measures.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "VisionPrescription.lensSpecification.prism",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "VisionPrescription.lensSpecification.prism.id",
"path" : "VisionPrescription.lensSpecification.prism.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "VisionPrescription.lensSpecification.prism.extension",
"path" : "VisionPrescription.lensSpecification.prism.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "VisionPrescription.lensSpecification.prism.modifierExtension",
"path" : "VisionPrescription.lensSpecification.prism.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "VisionPrescription.lensSpecification.prism.amount",
"path" : "VisionPrescription.lensSpecification.prism.amount",
"short" : "Amount of adjustment",
"definition" : "Amount of prism to compensate for eye alignment in fractional units.",
"requirements" : "Standard lens prescription measures.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "VisionPrescription.lensSpecification.prism.amount",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "decimal"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "VisionPrescription.lensSpecification.prism.base",
"path" : "VisionPrescription.lensSpecification.prism.base",
"short" : "up | down | in | out",
"definition" : "The relative base, or reference lens edge, for the prism.",
"requirements" : "Standard lens prescription measures.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "VisionPrescription.lensSpecification.prism.base",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "VisionBase"
}],
"strength" : "required",
"description" : "A coded concept listing the base codes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/vision-base-codes|4.0.1"
},
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "VisionPrescription.lensSpecification.add",
"path" : "VisionPrescription.lensSpecification.add",
"short" : "Added power for multifocal levels",
"definition" : "Power adjustment for multifocal lenses measured in dioptres (0.25 units).",
"requirements" : "Standard lens prescription measures.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "VisionPrescription.lensSpecification.add",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "decimal"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "VisionPrescription.lensSpecification.power",
"path" : "VisionPrescription.lensSpecification.power",
"short" : "Contact lens power",
"definition" : "Contact lens power measured in dioptres (0.25 units).",
"requirements" : "Standard contact lens prescription measures.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "VisionPrescription.lensSpecification.power",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "decimal"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "VisionPrescription.lensSpecification.backCurve",
"path" : "VisionPrescription.lensSpecification.backCurve",
"short" : "Contact lens back curvature",
"definition" : "Back curvature measured in millimetres.",
"requirements" : "Standard contact lens prescription measures.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "VisionPrescription.lensSpecification.backCurve",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "decimal"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "VisionPrescription.lensSpecification.diameter",
"path" : "VisionPrescription.lensSpecification.diameter",
"short" : "Contact lens diameter",
"definition" : "Contact lens diameter measured in millimetres.",
"requirements" : "Standard contact lens prescription measures.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "VisionPrescription.lensSpecification.diameter",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "decimal"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "VisionPrescription.lensSpecification.duration",
"path" : "VisionPrescription.lensSpecification.duration",
"short" : "Lens wear duration",
"definition" : "The recommended maximum wear period for the lens.",
"requirements" : "Standard contact lens prescription measures.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "VisionPrescription.lensSpecification.duration",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Quantity",
"profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "VisionPrescription.lensSpecification.color",
"path" : "VisionPrescription.lensSpecification.color",
"short" : "Color required",
"definition" : "Special color or pattern.",
"requirements" : "Standard contact lens prescription measures.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "VisionPrescription.lensSpecification.color",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "VisionPrescription.lensSpecification.brand",
"path" : "VisionPrescription.lensSpecification.brand",
"short" : "Brand required",
"definition" : "Brand recommendations or restrictions.",
"requirements" : "Standard lens prescription measures.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "VisionPrescription.lensSpecification.brand",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "VisionPrescription.lensSpecification.note",
"path" : "VisionPrescription.lensSpecification.note",
"short" : "Notes for coatings",
"definition" : "Notes for special requirements such as coatings and lens materials.",
"requirements" : "Standard lens prescription measures.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "VisionPrescription.lensSpecification.note",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Annotation"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
}]
},
"differential" : {
"element" : [{
"id" : "VisionPrescription",
"path" : "VisionPrescription",
"short" : "Prescription for vision correction products for a patient",
"definition" : "An authorization for the provision of glasses and/or contact lenses to a patient.",
"min" : 0,
"max" : "*",
"mapping" : [{
"identity" : "workflow",
"map" : "Request"
},
{
"identity" : "rim",
"map" : "CombinedVisionRequest"
}]
},
{
"id" : "VisionPrescription.identifier",
"path" : "VisionPrescription.identifier",
"short" : "Business Identifier for vision prescription",
"definition" : "A unique identifier assigned to this vision prescription.",
"requirements" : "Allows vision prescriptions to be distinguished and referenced.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Identifier"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Request.identifier"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "v2",
"map" : "ORC-2-Placer Order Number / ORC-3-Filler Order Number"
},
{
"identity" : "rim",
"map" : "id"
}]
},
{
"id" : "VisionPrescription.status",
"path" : "VisionPrescription.status",
"short" : "active | cancelled | draft | entered-in-error",
"definition" : "The status of the resource instance.",
"comment" : "This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.",
"requirements" : "Need to track the status of the resource as 'draft' resources may undergo further edits while 'active' resources are immutable and may only have their status changed to 'cancelled'.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isModifier" : true,
"isModifierReason" : "This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "VisionStatus"
}],
"strength" : "required",
"description" : "A code specifying the state of the resource instance.",
"valueSet" : "http://hl7.org/fhir/ValueSet/fm-status|4.0.1"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Request.status"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
},
{
"identity" : "rim",
"map" : "Act.status"
}]
},
{
"id" : "VisionPrescription.created",
"path" : "VisionPrescription.created",
"short" : "Response creation date",
"definition" : "The date this resource was created.",
"requirements" : "Need to record a timestamp for use by both the recipient and the issuer.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "dateTime"
}],
"isSummary" : true
},
{
"id" : "VisionPrescription.patient",
"path" : "VisionPrescription.patient",
"short" : "Who prescription is for",
"definition" : "A resource reference to the person to whom the vision prescription applies.",
"requirements" : "Needed to identify the patient for whom the vision prescription has been issued.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.subject"
},
{
"identity" : "w5",
"map" : "FiveWs.subject[x]"
},
{
"identity" : "v2",
"map" : "PID-3-Patient ID List"
},
{
"identity" : "rim",
"map" : "subject.role"
},
{
"identity" : "w5",
"map" : "FiveWs.subject"
}]
},
{
"id" : "VisionPrescription.encounter",
"path" : "VisionPrescription.encounter",
"short" : "Created during encounter / admission / stay",
"definition" : "A reference to a resource that identifies the particular occurrence of contact between patient and health care provider during which the prescription was issued.",
"requirements" : "Used in some jurisdictions to link clinical events to claim items.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Encounter"]
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Request.context"
},
{
"identity" : "w5",
"map" : "FiveWs.context"
},
{
"identity" : "v2",
"map" : "PV1-19-Visit Number"
},
{
"identity" : "rim",
"map" : "componentOf.patientEncounter"
}]
},
{
"id" : "VisionPrescription.dateWritten",
"path" : "VisionPrescription.dateWritten",
"short" : "When prescription was authorized",
"definition" : "The date (and perhaps time) when the prescription was written.",
"comment" : "Jurisdictions determine the valid lifetime of a prescription. Typically vision prescriptions are valid for two years from the date written.",
"requirements" : "Need to record a timestamp for use by both the recipient and the issuer.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "dateTime"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.authoredOn"
},
{
"identity" : "w5",
"map" : "FiveWs.recorded"
},
{
"identity" : "v2",
"map" : "RXE-32-Original Order Date/Time / ORC-9-Date/Time of Transaction"
},
{
"identity" : "rim",
"map" : "author.time"
}]
},
{
"id" : "VisionPrescription.prescriber",
"path" : "VisionPrescription.prescriber",
"short" : "Who authorized the vision prescription",
"definition" : "The healthcare professional responsible for authorizing the prescription.",
"requirements" : "Need to record the authorizing practitioner.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Request.requester"
},
{
"identity" : "w5",
"map" : "FiveWs.author"
},
{
"identity" : "v2",
"map" : "RXE-13-Ordering Provider's DEA Number / RXO-14-Ordering Provider's DEA Number / RXE-14-Pharmacist/Treatment Supplier's Verifier ID / RXO-15-Pharmacist/Treatment Supplier's Verifier ID / ORC-12-Ordering Provider / PRT-5-Participation Person: PRT-4-Participation='OP' (all but last deprecated)"
},
{
"identity" : "rim",
"map" : "author.role"
}]
},
{
"id" : "VisionPrescription.lensSpecification",
"path" : "VisionPrescription.lensSpecification",
"short" : "Vision lens authorization",
"definition" : "Contain the details of the individual lens specifications and serves as the authorization for the fullfillment by certified professionals.",
"min" : 1,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "component.supplyEvent"
}]
},
{
"id" : "VisionPrescription.lensSpecification.product",
"path" : "VisionPrescription.lensSpecification.product",
"short" : "Product to be supplied",
"definition" : "Identifies the type of vision correction product which is required for the patient.",
"requirements" : "Need to identify whether glasses or contacts.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "VisionProduct"
}],
"strength" : "example",
"description" : "A coded concept describing the vision products.",
"valueSet" : "http://hl7.org/fhir/ValueSet/vision-product"
},
"mapping" : [{
"identity" : "v2",
"map" : "RXE-2-Give Code / RXO-1-Requested Give Code / RXD-2-Dispense/Give Code"
},
{
"identity" : "rim",
"map" : "consumable.role"
}]
},
{
"id" : "VisionPrescription.lensSpecification.eye",
"path" : "VisionPrescription.lensSpecification.eye",
"short" : "right | left",
"definition" : "The eye for which the lens specification applies.",
"comment" : "May also appear as OD (oculus dexter) for the right eye and OS (oculus siniter) for the left eye.",
"requirements" : "Needed to identify which eye the lens specification applies to.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "VisionEyes"
}],
"strength" : "required",
"description" : "A coded concept listing the eye codes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/vision-eye-codes|4.0.1"
},
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "VisionPrescription.lensSpecification.sphere",
"path" : "VisionPrescription.lensSpecification.sphere",
"short" : "Power of the lens",
"definition" : "Lens power measured in dioptres (0.25 units).",
"comment" : "The value is negative for near-sighted and positive for far sighted.\nOften insurance will not cover a lens with power between +75 and -75.",
"requirements" : "Standard lens prescription measures.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "decimal"
}],
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "VisionPrescription.lensSpecification.cylinder",
"path" : "VisionPrescription.lensSpecification.cylinder",
"short" : "Lens power for astigmatism",
"definition" : "Power adjustment for astigmatism measured in dioptres (0.25 units).",
"requirements" : "Standard lens prescription measures.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "decimal"
}],
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "VisionPrescription.lensSpecification.axis",
"path" : "VisionPrescription.lensSpecification.axis",
"short" : "Lens meridian which contain no power for astigmatism",
"definition" : "Adjustment for astigmatism measured in integer degrees.",
"comment" : "The limits are +180 and -180 degrees.",
"requirements" : "Standard lens prescription measures.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "integer"
}],
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "VisionPrescription.lensSpecification.prism",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "Prism"
}],
"path" : "VisionPrescription.lensSpecification.prism",
"short" : "Eye alignment compensation",
"definition" : "Allows for adjustment on two axis.",
"requirements" : "Standard lens prescription measures.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "VisionPrescription.lensSpecification.prism.amount",
"path" : "VisionPrescription.lensSpecification.prism.amount",
"short" : "Amount of adjustment",
"definition" : "Amount of prism to compensate for eye alignment in fractional units.",
"requirements" : "Standard lens prescription measures.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "decimal"
}],
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "VisionPrescription.lensSpecification.prism.base",
"path" : "VisionPrescription.lensSpecification.prism.base",
"short" : "up | down | in | out",
"definition" : "The relative base, or reference lens edge, for the prism.",
"requirements" : "Standard lens prescription measures.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "VisionBase"
}],
"strength" : "required",
"description" : "A coded concept listing the base codes.",
"valueSet" : "http://hl7.org/fhir/ValueSet/vision-base-codes|4.0.1"
},
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "VisionPrescription.lensSpecification.add",
"path" : "VisionPrescription.lensSpecification.add",
"short" : "Added power for multifocal levels",
"definition" : "Power adjustment for multifocal lenses measured in dioptres (0.25 units).",
"requirements" : "Standard lens prescription measures.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "decimal"
}],
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "VisionPrescription.lensSpecification.power",
"path" : "VisionPrescription.lensSpecification.power",
"short" : "Contact lens power",
"definition" : "Contact lens power measured in dioptres (0.25 units).",
"requirements" : "Standard contact lens prescription measures.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "decimal"
}],
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "VisionPrescription.lensSpecification.backCurve",
"path" : "VisionPrescription.lensSpecification.backCurve",
"short" : "Contact lens back curvature",
"definition" : "Back curvature measured in millimetres.",
"requirements" : "Standard contact lens prescription measures.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "decimal"
}],
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "VisionPrescription.lensSpecification.diameter",
"path" : "VisionPrescription.lensSpecification.diameter",
"short" : "Contact lens diameter",
"definition" : "Contact lens diameter measured in millimetres.",
"requirements" : "Standard contact lens prescription measures.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "decimal"
}],
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "VisionPrescription.lensSpecification.duration",
"path" : "VisionPrescription.lensSpecification.duration",
"short" : "Lens wear duration",
"definition" : "The recommended maximum wear period for the lens.",
"requirements" : "Standard contact lens prescription measures.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Quantity",
"profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
}],
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "VisionPrescription.lensSpecification.color",
"path" : "VisionPrescription.lensSpecification.color",
"short" : "Color required",
"definition" : "Special color or pattern.",
"requirements" : "Standard contact lens prescription measures.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "VisionPrescription.lensSpecification.brand",
"path" : "VisionPrescription.lensSpecification.brand",
"short" : "Brand required",
"definition" : "Brand recommendations or restrictions.",
"requirements" : "Standard lens prescription measures.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "VisionPrescription.lensSpecification.note",
"path" : "VisionPrescription.lensSpecification.note",
"short" : "Notes for coatings",
"definition" : "Notes for special requirements such as coatings and lens materials.",
"requirements" : "Standard lens prescription measures.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Annotation"
}],
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
}]
}
}
},
{
"fullUrl" : "http://hl7.org/fhir/StructureDefinition/MetadataResource",
"resource" : {
"resourceType" : "StructureDefinition",
"id" : "MetadataResource",
"meta" : {
"lastUpdated" : "2019-11-01T09:29:23.356+11:00"
},
"text" : {
"status" : "generated",
"div" : "Name Flags Card. Type Description & Constraints MetadataResource ITU DomainResource Common Ancestor 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 Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension url Σ 0..1 uri Canonical identifier for this metadata resource, represented as a URI (globally unique) version Σ 0..1 string Business version of the metadata resource name ΣI 0..1 string Name for this metadata resource (computer friendly) title Σ 0..1 string Name for this metadata resource (human friendly) status ?!Σ 1..1 code draft | active | retired | unknown
PublicationStatus (Required) experimental Σ 0..1 boolean For testing purposes, not real usage date Σ 0..1 dateTime Date last changed publisher Σ 0..1 string Name of the publisher (organization or individual) contact Σ 0..* ContactDetail Contact details for the publisher
description 0..1 markdown Natural language description of the metadata resource useContext Σ 0..* UsageContext The context that the content is intended to support
jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for metadata resource (if applicable)
Jurisdiction (Extensible)
Documentation for this format
"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "fhir"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/MetadataResource",
"version" : "4.0.1",
"name" : "MetadataResource",
"status" : "draft",
"date" : "2019-11-01T09:29:23+11:00",
"publisher" : "Health Level Seven International (FHIR Infrastructure)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/fiwg/index.cfm"
}]
}],
"description" : "Common Ancestor declaration for conformance and knowledge artifact resources.",
"fhirVersion" : "4.0.1",
"mapping" : [{
"identity" : "workflow",
"uri" : "http://hl7.org/fhir/workflow",
"name" : "Workflow Pattern"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/fivews",
"name" : "FiveWs Pattern Mapping"
},
{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
}],
"kind" : "logical",
"abstract" : false,
"type" : "MetadataResource",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "MetadataResource",
"path" : "MetadataResource",
"short" : "Common Ancestor declaration for definitional resources",
"definition" : "Common Ancestor declaration for conformance and knowledge artifact resources.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "MetadataResource",
"min" : 1,
"max" : "1"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "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",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.`div`.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "inv-0",
"severity" : "warning",
"human" : "Name should be usable as an identifier for the module by machine processing applications such as code generation",
"expression" : "name.matches('[A-Z]([A-Za-z0-9_]){0,254}')",
"xpath" : "not(exists(f:name/@value)) or matches(f:name/@value, '[A-Z]([A-Za-z0-9_]){0,254}')"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "workflow",
"map" : "Definition"
}]
},
{
"id" : "MetadataResource.id",
"path" : "MetadataResource.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MetadataResource.meta",
"path" : "MetadataResource.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MetadataResource.implicitRules",
"path" : "MetadataResource.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "MetadataResource.language",
"path" : "MetadataResource.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "MetadataResource.text",
"path" : "MetadataResource.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "MetadataResource.contained",
"path" : "MetadataResource.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MetadataResource.extension",
"path" : "MetadataResource.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MetadataResource.modifierExtension",
"path" : "MetadataResource.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "MetadataResource.url",
"path" : "MetadataResource.url",
"short" : "Canonical identifier for this metadata resource, represented as a URI (globally unique)",
"definition" : "An absolute URI that is used to identify this metadata resource when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this metadata resource is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the metadata resource is stored on different servers.",
"comment" : "Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.\n\nThe determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions). \n\nIn some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.",
"requirements" : "Allows the metadata resource to be referenced by a single globally unique identifier.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MetadataResource.url",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.url"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
}]
},
{
"id" : "MetadataResource.version",
"path" : "MetadataResource.version",
"short" : "Business version of the metadata resource",
"definition" : "The identifier that is used to identify this version of the metadata resource when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the metadata resource author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.",
"comment" : "There may be different metadata resource instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the metadata resource with the format [url]|[version].",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MetadataResource.version",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.version"
},
{
"identity" : "w5",
"map" : "FiveWs.version"
}]
},
{
"id" : "MetadataResource.name",
"path" : "MetadataResource.name",
"short" : "Name for this metadata resource (computer friendly)",
"definition" : "A natural language name identifying the metadata resource. This name should be usable as an identifier for the module by machine processing applications such as code generation.",
"comment" : "The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.",
"requirements" : "Support human navigation and code generation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MetadataResource.name",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"condition" : ["inv-0"],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "MetadataResource.title",
"path" : "MetadataResource.title",
"short" : "Name for this metadata resource (human friendly)",
"definition" : "A short, descriptive, user-friendly title for the metadata resource.",
"comment" : "This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MetadataResource.title",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.title"
}]
},
{
"id" : "MetadataResource.status",
"path" : "MetadataResource.status",
"short" : "draft | active | retired | unknown",
"definition" : "The status of this metadata resource. Enables tracking the life-cycle of the content.",
"comment" : "Allows filtering of metadata resources that are appropriate for use versus not.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "MetadataResource.status",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This is labeled as \"Is Modifier\" because applications should not use a retired {{title}} without due consideration",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "PublicationStatus"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "The lifecycle status of an artifact.",
"valueSet" : "http://hl7.org/fhir/ValueSet/publication-status|4.0.1"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.status"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
}]
},
{
"id" : "MetadataResource.experimental",
"path" : "MetadataResource.experimental",
"short" : "For testing purposes, not real usage",
"definition" : "A Boolean value to indicate that this metadata resource is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.",
"comment" : "Allows filtering of metadata resources that are appropriate for use versus not.",
"requirements" : "Enables experimental content to be developed following the same lifecycle that would be used for a production-level metadata resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MetadataResource.experimental",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.experimental"
},
{
"identity" : "w5",
"map" : "FiveWs.class"
}]
},
{
"id" : "MetadataResource.date",
"path" : "MetadataResource.date",
"short" : "Date last changed",
"definition" : "The date (and optionally time) when the metadata resource was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the metadata resource changes.",
"comment" : "Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the metadata resource. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.",
"alias" : ["Revision Date"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "MetadataResource.date",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.date"
},
{
"identity" : "w5",
"map" : "FiveWs.recorded"
}]
},
{
"id" : "MetadataResource.publisher",
"path" : "MetadataResource.publisher",
"short" : "Name of the publisher (organization or individual)",
"definition" : "The name of the organization or individual that published the metadata resource.",
"comment" : "Usually an organization but may be an individual. The publisher (or steward) of the metadata resource is the organization or individual primarily responsible for the maintenance and upkeep of the metadata resource. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the metadata resource. This item SHOULD be populated unless the information is available from context.",
"requirements" : "Helps establish the \"authority/credibility\" of the metadata resource. May also allow for contact.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MetadataResource.publisher",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.publisher"
},
{
"identity" : "w5",
"map" : "FiveWs.witness"
}]
},
{
"id" : "MetadataResource.contact",
"path" : "MetadataResource.contact",
"short" : "Contact details for the publisher",
"definition" : "Contact details to assist a user in finding and communicating with the publisher.",
"comment" : "May be a web site, an email address, a telephone number, etc.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MetadataResource.contact",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "ContactDetail"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.contact"
}]
},
{
"id" : "MetadataResource.description",
"path" : "MetadataResource.description",
"short" : "Natural language description of the metadata resource",
"definition" : "A free text natural language description of the metadata resource from a consumer's perspective.",
"comment" : "This description can be used to capture details such as why the metadata resource was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the metadata resource as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the metadata resource is presumed to be the predominant language in the place the metadata resource was created).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MetadataResource.description",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "markdown"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.description"
}]
},
{
"id" : "MetadataResource.useContext",
"path" : "MetadataResource.useContext",
"short" : "The context that the content is intended to support",
"definition" : "The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate metadata resource instances.",
"comment" : "When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.",
"requirements" : "Assist in searching for appropriate content.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MetadataResource.useContext",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "UsageContext"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.useContext"
}]
},
{
"id" : "MetadataResource.jurisdiction",
"path" : "MetadataResource.jurisdiction",
"short" : "Intended jurisdiction for metadata resource (if applicable)",
"definition" : "A legal or geographic region in which the metadata resource is intended to be used.",
"comment" : "It may be possible for the metadata resource to be used in jurisdictions other than those for which it was originally designed or intended.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MetadataResource.jurisdiction",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Jurisdiction"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "extensible",
"description" : "Countries and regions within which this artifact is targeted for use.",
"valueSet" : "http://hl7.org/fhir/ValueSet/jurisdiction"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.jurisdiction"
}]
}]
},
"differential" : {
"element" : [{
"id" : "MetadataResource",
"path" : "MetadataResource",
"short" : "Common Ancestor declaration for definitional resources",
"definition" : "Common Ancestor declaration for conformance and knowledge artifact resources.",
"min" : 1,
"max" : "1",
"constraint" : [{
"key" : "inv-0",
"severity" : "warning",
"human" : "Name should be usable as an identifier for the module by machine processing applications such as code generation",
"expression" : "name.matches('[A-Z]([A-Za-z0-9_]){0,254}')",
"xpath" : "not(exists(f:name/@value)) or matches(f:name/@value, '[A-Z]([A-Za-z0-9_]){0,254}')"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Definition"
}]
},
{
"id" : "MetadataResource.url",
"path" : "MetadataResource.url",
"short" : "Canonical identifier for this metadata resource, represented as a URI (globally unique)",
"definition" : "An absolute URI that is used to identify this metadata resource when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this metadata resource is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the metadata resource is stored on different servers.",
"comment" : "Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.\n\nThe determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions). \n\nIn some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.",
"requirements" : "Allows the metadata resource to be referenced by a single globally unique identifier.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "uri"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.url"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
}]
},
{
"id" : "MetadataResource.version",
"path" : "MetadataResource.version",
"short" : "Business version of the metadata resource",
"definition" : "The identifier that is used to identify this version of the metadata resource when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the metadata resource author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.",
"comment" : "There may be different metadata resource instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the metadata resource with the format [url]|[version].",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.version"
},
{
"identity" : "w5",
"map" : "FiveWs.version"
}]
},
{
"id" : "MetadataResource.name",
"path" : "MetadataResource.name",
"short" : "Name for this metadata resource (computer friendly)",
"definition" : "A natural language name identifying the metadata resource. This name should be usable as an identifier for the module by machine processing applications such as code generation.",
"comment" : "The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.",
"requirements" : "Support human navigation and code generation.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"condition" : ["inv-0"],
"isSummary" : true
},
{
"id" : "MetadataResource.title",
"path" : "MetadataResource.title",
"short" : "Name for this metadata resource (human friendly)",
"definition" : "A short, descriptive, user-friendly title for the metadata resource.",
"comment" : "This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.title"
}]
},
{
"id" : "MetadataResource.status",
"path" : "MetadataResource.status",
"short" : "draft | active | retired | unknown",
"definition" : "The status of this metadata resource. Enables tracking the life-cycle of the content.",
"comment" : "Allows filtering of metadata resources that are appropriate for use versus not.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isModifier" : true,
"isModifierReason" : "This is labeled as \"Is Modifier\" because applications should not use a retired {{title}} without due consideration",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "PublicationStatus"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "required",
"description" : "The lifecycle status of an artifact.",
"valueSet" : "http://hl7.org/fhir/ValueSet/publication-status|4.0.1"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.status"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
}]
},
{
"id" : "MetadataResource.experimental",
"path" : "MetadataResource.experimental",
"short" : "For testing purposes, not real usage",
"definition" : "A Boolean value to indicate that this metadata resource is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.",
"comment" : "Allows filtering of metadata resources that are appropriate for use versus not.",
"requirements" : "Enables experimental content to be developed following the same lifecycle that would be used for a production-level metadata resource.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "boolean"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.experimental"
},
{
"identity" : "w5",
"map" : "FiveWs.class"
}]
},
{
"id" : "MetadataResource.date",
"path" : "MetadataResource.date",
"short" : "Date last changed",
"definition" : "The date (and optionally time) when the metadata resource was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the metadata resource changes.",
"comment" : "Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the metadata resource. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.",
"alias" : ["Revision Date"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "dateTime"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.date"
},
{
"identity" : "w5",
"map" : "FiveWs.recorded"
}]
},
{
"id" : "MetadataResource.publisher",
"path" : "MetadataResource.publisher",
"short" : "Name of the publisher (organization or individual)",
"definition" : "The name of the organization or individual that published the metadata resource.",
"comment" : "Usually an organization but may be an individual. The publisher (or steward) of the metadata resource is the organization or individual primarily responsible for the maintenance and upkeep of the metadata resource. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the metadata resource. This item SHOULD be populated unless the information is available from context.",
"requirements" : "Helps establish the \"authority/credibility\" of the metadata resource. May also allow for contact.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.publisher"
},
{
"identity" : "w5",
"map" : "FiveWs.witness"
}]
},
{
"id" : "MetadataResource.contact",
"path" : "MetadataResource.contact",
"short" : "Contact details for the publisher",
"definition" : "Contact details to assist a user in finding and communicating with the publisher.",
"comment" : "May be a web site, an email address, a telephone number, etc.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "ContactDetail"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.contact"
}]
},
{
"id" : "MetadataResource.description",
"path" : "MetadataResource.description",
"short" : "Natural language description of the metadata resource",
"definition" : "A free text natural language description of the metadata resource from a consumer's perspective.",
"comment" : "This description can be used to capture details such as why the metadata resource was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the metadata resource as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the metadata resource is presumed to be the predominant language in the place the metadata resource was created).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "markdown"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.description"
}]
},
{
"id" : "MetadataResource.useContext",
"path" : "MetadataResource.useContext",
"short" : "The context that the content is intended to support",
"definition" : "The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate metadata resource instances.",
"comment" : "When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.",
"requirements" : "Assist in searching for appropriate content.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "UsageContext"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.useContext"
}]
},
{
"id" : "MetadataResource.jurisdiction",
"path" : "MetadataResource.jurisdiction",
"short" : "Intended jurisdiction for metadata resource (if applicable)",
"definition" : "A legal or geographic region in which the metadata resource is intended to be used.",
"comment" : "It may be possible for the metadata resource to be used in jurisdictions other than those for which it was originally designed or intended.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Jurisdiction"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "extensible",
"description" : "Countries and regions within which this artifact is targeted for use.",
"valueSet" : "http://hl7.org/fhir/ValueSet/jurisdiction"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.jurisdiction"
}]
}]
}
}
}]
}